我创建了一个API,提供名为"Thumbnail"的资源(/缩略图)
{
"name": "toto",
"uri": "http://xxx"
}
Run Code Online (Sandbox Code Playgroud)
另一方面,我有多个资源,其中包含缩略图资源(如/ articles,/ videos ...):
{
"name": "playlist",
"thumbnail":
{
"name": "toto",
"uri": "http://xxx"
}
}
Run Code Online (Sandbox Code Playgroud)
当我在BluePrint markdown中编写这些web服务的模式时,我希望能够重用我为Thumbnail模式创建的模式,以便不重复模式中的代码.我对Trait功能很感兴趣(https://github.com/apiaryio/api-blueprint/issues/47),但我不知道它是否符合我的需求,是否适用于aglio和dredd.
你知道在我的情况下做的最好的事情吗?
我正在研究API Blueprint中新数据结构语法的可能性,尤其是MSON.是否可以附加或更确切地指定类似图案(正则表达式)的东西?没有找到关于这个主题的任何内容.
我正在使用API Blueprint和Agelo来呈现我的 API 文档。使用枚举类型时,我观察到一种奇怪的行为。响应未显示定义的枚举值,而架构显示所有枚举值(这是预期的)以及声明的值(“星期一”-参考实际值)。
数据结构部分
# Data Structures
## Days (enum[string])
+ `Monday`
+ `Tuesday`
+ `Wednesday`
+ `Thursday`
## ListEntry
- playOrder: 1 (number)
- Id: 37a21975a499494f03367 (string)
- programDay: `Tuesday` (Days)
## `sample-request-200`
- id: 58828b2941cc351348 (string)
- startDate: `2019-08-01T11:00:00.000Z` (string)
- endDate: `2019-08-05T11:55:59.000Z` (string)
- Language: `en-US` (string)
- entries: ListEntry (array[object])
Run Code Online (Sandbox Code Playgroud)
API请求文档部分
+ Request
+ Headers
Content-Type: application/json
+ Attributes (sample-request-200)
Run Code Online (Sandbox Code Playgroud)
实际的
---- JSON Body ----
{
"playOrder": 1,
"Id": "37a21975a499494f03367",
"programDay": …
Run Code Online (Sandbox Code Playgroud)