在Apiary.io中为每个响应指定描述
是否可以为每个请求的响应指定描述？ 假设我们有一个请求 ### Retrieve resource [GET] + Headers If-None-Match: "Version1" 还有2个回应 + Response 200 (applicatio...
如何使用Apiary记录多部分请求？
我想记录一个如下的多部分请求：Content-Length: 477 Content-Type: multipart/form-data; boundary=---BOUNDARY -----BOUNDARY Content-Disposition: form-data; name="ima...
Apiary：将API导出为JSON，以生成客户端代码
我们都知道Apiary很棒（或者不是..我觉得它很棒），但我想知道如何将它进一步发挥，使用户能够导出API的JSON描述？这样开发人员就可以编写客户端代码生成脚本。 这应该会有所帮助： http://ttezel.github.io/blog/2013/02/23/stop-writing-...
优秀的休息代码生成和文档工具
我一直在考虑一种文档工具，用于构建适用于多个客户端的后端Web服务，并支持OAuth和可能的多版本。我已经知道了Apiary，但是进行了一些调查后，我发现还有其他相当不错的解决方案，并且承诺很有吸引力。 RAML似乎提供了良好的代码生成和API可重用性。但它似乎无法创建模拟服务器。而且我不明...
我可以提供多个示例回答吗？
我正在为一款API撰写规范，其中响应中包含的字段会有所不同。我希望能够提供多个示例来展示这一点。我的使用情况如下： 1. API调用之一具有一个“include”参数，允许用户指定响应中包含的一些额外字段； 2. 对于某些API调用，响应中包含的字段取决于与用户API密钥相关联的权限。 我...
在Apiary中，表示输入参数为日期/时间的正确格式是什么？
我正在编辑我所在项目的一些Apiary文档，并需要标识其中一个API调用的参数为datetime字符串。由于Apiary似乎无法处理此参数的格式，因此我想知道在Apiary中记录此参数的建议方法。 为了演示，我使用了Apiary的标准默认文档，并修改了Choice文档以接受一个datetim...
为一对多关系暴露RESTful端点
考虑以下两个资源之间的关系： 学院有许多教职员工 教职员工隶属于一个学院 很明显，这里的教职员工不是一流资源。 现在我需要以下操作的终端点。 在该学院中创建一个新的教职员工。一种可能的方法是进行两个操作。 POST /faculties/ PUT /college/1/facu...
什么是 Api Blueprint 可以理解的二维键值格式？
我正在使用Api Blueprint编写RESTful搜索API的API文档。我希望能够向API传递筛选器，以便我可以组装:filter[filtername1]=filtervalue1 filter[filtername2]=filtervalue2 根据这个问题，我正在使用百分号编码的方...
API Blueprint和Swagger的独特目的是什么？
我正在尝试以云本地方式开发应用程序。 我正在尝试使用 API first 设计我的应用程序。 哪种 API 文档工具适合我使用？ 哪一个更适合 API first 合同？ 它们中的哪一个适合在哪里使用？
如何为json请求对象指定可选元素
在API蓝图中，我想要指定一个可选的JSON元素以用于POST消息。例如： ### Add a new User [POST] To add a User send a JSON ..... + Request (application/json) { ...