apiblueprint相关内容
我一直在考虑一种文档工具,用于为要在多个客户端中使用的 Web 服务构建后端,以及 OAuth 和多个修订的可能性.我已经了解养蜂场,但做了一些研究,我发现其他相当不错的 解决方案 承诺有利可图. RAML 似乎有望实现良好的代码生成和 api 可重用性.但它似乎无法创建模拟服务器.而且我不明白为什么不能使用 apiblueprint 为 REST API 生成客户端库和服务器端骨架.
..
我正在尝试使用规范的新属性和数据结构部分为 API 蓝图记录端点. 我的请求负载如下所示: {"url": "http://requestb.in/11v7i7e1",“活动":真实,“类型":[{"name": "销售",“版本":“2.0"},{"name": "产品",“版本":“2.0"}]} 我的响应负载看起来像这样: {“数据": {"id": "dc85058a-a683
..
我们都知道蜂房的岩石(或者不是.我想是的),我想知道进一步采取措施允许用户导出API的JSON描述会采取什么措施? (以便开发人员可以编写客户端代码生成脚本) 这应该有助于: http://ttezel.github.io/blog/2013/02/23/stop-writing-rest-api-clients/ 解决方案 您可以探索两个方向: 您可以使用 Alpaca 生成
..
我遇到的问题类似于我有一个看起来像这样的JSON: { "photos": [ { "key": "y37dmj10jkwof/moOIUB8912JKVgh", "caption": "A world of gamers.", "tags": [ "game", "japan" ], "
..
api蓝图或Apiary.io是否支持对API进行版本控制的概念?特别是,我通过URI这样对API进行版本控制: GET /api/v2/SomeResource/ 在上面的示例中,这意味着我正在调用API的版本2("v2"). api蓝图支持吗?如何记录给定操作或整个API的多个版本? 解决方案 您可以使用HOST标头表示: HOST: http://example.co
..
是否可以为对某个请求的每个响应指定描述?假设我们有一个请求 ### Retrieve resource [GET] + Headers If-None-Match: "Version1" 还有2个回复 + Response 200 (application/xml) + Headers ETag: "Versi
..
我正在尝试创建模拟api服务以进行测试.我们已经在另一个团队上使用了Apiary,所以我从那里开始. 到目前为止,我已经注意到,如果要进行两个单独的调用,则需要模拟两个请求.例如,要获取ID为1和2的笔记,需要明确写出如下响应: /notes/1 /notes/2 有办法避免这种情况吗?诚然,我仍在努力创建蓝图. 解决方案 看看私人e9e59-pingdomcheck.a
..
我正在尝试API蓝图,发现了一些我不太清楚的东西. 1.如何记录POST正文参数? 有+ Parameters,但仅记录查询参数.如果现在我要描述POST API,则无法记录POST参数(application/x-www-form-urlencoded). JSON也是如此(请参阅#3). 2.有没有办法在响应中添加描述? 我尝试了 + Response 403 I
..
我想证明实际JSON字段本身代表什么. 我已经记录了GET语句和参数,但这并没有提供完整的文档给用户. 因此,在下面的示例中,我将如何添加有关"OtherFields"的注释.支持这个吗?还是我需要在其他地方制作配套文档. ## View Applications [/cat{?sort}{&order}{&page}] ### List all Applications ##
..
我正在尝试在API Blueprint中记录查询参数,但是我不确定是否正确完成了该操作.该资源如下所示: DELETE http://baasar.apiary-mock.com/user/{appId}/{userId} 该请求将停用用户,而以下请求将删除用户对象: DELETE http://baasar.apiary-mock.com/user/{appId}/{userId
..
我想记录一个多部分请求,如下所示: Content-Length: 477 Content-Type: multipart/form-data; boundary=---BOUNDARY -----BOUNDARY Content-Disposition: form-data; name="image[file]"; filename="image.jpg" Content-Type: i
..
我正在尝试通过不同的参数获得不同的响应,但是某些方法不起作用. 这是我的API: ## Question [/questions/{question_id}] A Question object has the following attributes: + Parameters + question_id: `1` (number, required) - ID of t
..
我一直在考虑使用一种文档工具来构建Web服务的后端,以便与OAuth和多个修订版本一起在多个客户端中使用.我已经知道了养蜂场,但做了一些研究后发现我发现了其他相当不错的解决方案具有可观的承诺. RAML似乎有望带来良好的代码生成和api可重用性.但是它似乎无法创建模拟服务器.而且我不明白为什么不能使用apiblueprint为REST API生成客户端库和服务器端框架. 对我们来说,最
..
我在“客户"和“预算"之间有如下关联: //Client.js module.exports = { primaryKey: 'id', attributes: { id: { type: 'number', unique: true, autoIncrement: true }, name: { type:
..
我有一张桌子: | This | Is | A | Table | | :--- | -- | - | ----: | | foo | ba | r | elbaT | 我希望表格显示在Markdown文件的中心,而不是左对齐.我不是要对齐文本,而是要对齐整个表格本身.我需要依靠HTML/CSS来实现我想要的吗? 这是针对Apiary.io项目的.
..
在API蓝图中,我希望为POST消息指定一个可选的json元素. 示例; ### Add a new User [POST] To add a User send a JSON ..... + Request (application/json) { "name": "A name", "age": 30 }
..
使用Rails在URL的参数中添加散列的方式如下所示: http://api.example .com?person [first] = Jane& person [last] = Doe& person [email] = jane@doe.com 如何格式化API Blueprint文档以容纳可用哈希列表? 参数 person [first]
..
我试图记录与API蓝图端点,使用规范的新属性和数据结构部分。 我的请求负载是这样的: { “URL”:“http://requestb.in/11v7i7e1” “主动”:真实, “类型”:[ { “名”:“销售”, “版本”:“2.0” }, {
..