2017-06-19 53 views
0

在我的RAML 1.0規範中,我想表示一個uriParameter,它的值是枚舉令牌的集合列表之一。例如,_format只能是以下之一:csv,jsonttlRAML:表示具有固定枚舉值的URL參數

據我所知,在閱讀RAML規範時,除非我包含JSON模式聲明,否則目前不可能。 RAML可以在沒有JSON模式的情況下對枚舉進行編碼,如果是這樣,怎麼辦?

回答

1

是可以的話,通過使用RAML 1 data types

「數據類型可以描述一個鹼或資源URI參數,查詢參數,請求或響應報頭,或一個請求或響應身體的數據類型是內置in或custom。內置類型可用於API預期數據的任何位置。自定義類型可通過擴展內置類型以及內置類型命名和使用來定義「

例如:

#%RAML 1.0 
title: bla 
types: 
    foo: 
    type: string 
    enum: [ json, csv, ttl ] 
/bar/{_format}: 
    uriParameters: 
    _format: 
     type: foo 
    get: