RAML:表示具有固定枚举值的 URL 参数
RAML: representing a URL parameter that has a fixed enumeration of values
在我的 RAML 1.0 规范中,我想表示一个 uriParameter
,其值是一组枚举标记的列表之一。例如,_format
只能是以下之一:csv
、json
或 ttl
.
据我阅读 RAML 规范所知,目前这是不可能的,除非我包含 JSON 模式声明。 RAML 可以在没有 JSON 架构的情况下对枚举进行编码吗?如果可以,如何编码?
可以,使用 RAML 1 data types:
"Data types can describe a base or resource URI parameter, a query parameter, a request or response header, or a request or response body. Data types are built-in or custom. A built-in type can be used anywhere the API expects data. Custom types can be defined by extending the built-in types as well as named and used like built-in type"
示例:
#%RAML 1.0
title: bla
types:
foo:
type: string
enum: [ json, csv, ttl ]
/bar/{_format}:
uriParameters:
_format:
type: foo
get:
在我的 RAML 1.0 规范中,我想表示一个 uriParameter
,其值是一组枚举标记的列表之一。例如,_format
只能是以下之一:csv
、json
或 ttl
.
据我阅读 RAML 规范所知,目前这是不可能的,除非我包含 JSON 模式声明。 RAML 可以在没有 JSON 架构的情况下对枚举进行编码吗?如果可以,如何编码?
可以,使用 RAML 1 data types:
"Data types can describe a base or resource URI parameter, a query parameter, a request or response header, or a request or response body. Data types are built-in or custom. A built-in type can be used anywhere the API expects data. Custom types can be defined by extending the built-in types as well as named and used like built-in type"
示例:
#%RAML 1.0
title: bla
types:
foo:
type: string
enum: [ json, csv, ttl ]
/bar/{_format}:
uriParameters:
_format:
type: foo
get: