鉴于一些API文档docs.someurl.apiary.io(如http://docs.themoviedb.apiary.io),是否有某种方法可以看到非格式化的源API api蓝图降价source.themoviedb.apiary.io？
我认为像我这样的初学者可以查阅原始数据.
我写了一个设计为"可卷曲"的小型Web服务,因此它依赖application/x-www-form-urlencoded于POST请求中的参数,例如:
curl http://api.example.com/ -d param1=foo -d param2=bar
我想使用Apiary记录此服务,但我一直无法找到为这些参数提供结构化文档的方法.我可以提供这样的示例请求......
+ Request (application/x-www-form-urlencoded)
param1=foo¶m2=bar
...但是这不允许我提供有关各个参数的文档(并且不适合在蜂房控制台中进行测试,因为它无法为各种参数提供输入字段).
我已经阅读了几次api蓝图规范,但我一直无法找到一个好的解决方案.有没有办法为这些参数提供结构化文档？
api blueprint或Apiary.io是否支持对API进行版本控制的概念？特别是,我通过这样的URI对我的API进行版本控制:
GET /api/v2/SomeResource/
在上面的示例中,这意味着我正在调用API的版本2("v2").api蓝图是否支持此功能？如何记录给定操作或整个API的多个版本？
我想定义Apiary参数的选项,我目前在描述中列出它们:
m(可选,字符串,m)...测量例如m =米,km =公里,yd =码,mi =英里我所谓的参数部分解决方案是
+ fields: [firstField, secondField] (array[enum], optional)
+ Members
+ firstField
+ secondField
+ extraField
+ dummyField
但它在语义错误上失败了:
参数字段的示例值[firstField,secondField]不在其预期值列表中
我想注释一些错误响应,如下所示:
* Response 412
If the Etag supplied in `If-Match` didn’t match.
* Response 428
If the request didn’t include the header `If-Match`.
但解析器(snowcrash)似乎将注释解释为响应主体.
我如何注释这些回复并让snowcrash明白它们是注释？
我没有太多运气试图使用资源丰富的文档来使用Rails的数组参数表示法的API URI
例如(为清晰起见,未编码的URL):
/api/v2/profiles?ids[]=35&ids[]=47&ids[]=12&ids[]=132
和实际编码的URL:
/api/v2/profiles?ids%5b%5d=35&ids%5b%5d=47&ids%5b%5d=12&ids%5b%5d=132
这不起作用:
## Profiles [/api/v2/profiles{?ids%5b%5d*}]
### List profiles [GET]
+ Parameters
+ ids%5b%5d (required, number) ... ID of a profile to fetch. May be specified multiple times.
针对beta 3列布局进行测试.没有尝试旧的布局.
我正在试图弄清楚如何描述/定义POST/PUT的请求体属性/参数.这是我正在尝试做的一个例子,但我在文档中的任何地方都找不到它(我希望有一种方法可以查看任何公共蜂房文档的降价):http://docs.bynder. apiary.io/#reference/metaproperties/metaproperty-access/save-new-metaproperty
请参阅"请求"部分下的说明和属性定义？我怎么做？