问题标签 [apiblueprint]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
3 回答
1160 浏览

apiblueprint - api蓝图中给定端点的多个响应

是否可以在 API 蓝图中为给定端点定义一组可能的响应?

例如,如果我有一个端点,例如 /movie/{id} 我希望能够定义一组电影记录,以便在模拟服务器中我可以 GET /movie/1 或 GET /movie/2 或 GET /movie/3 并获取相关记录。

我见过的所有例子似乎都只定义了一种可能的反应。

0 投票
1 回答
461 浏览

ruby-on-rails - 创建 Blueprint API 文档时如何在 URL 中格式化基于哈希的参数?

使用 Rails 在 URL 的参数中添加哈希的方式,如下所示:

如何格式化 API Blueprint 文档以容纳可用哈希列表?

  • 参数
    • person[first] (required, string, Jane) ... 名字

当我执行文件时,这是不合法的。

欢迎任何想法或提示!

0 投票
1 回答
494 浏览

apiblueprint - Api Blueprint 中的语义问题抱怨忽略额外的响应标头

在Apiary创建 API 蓝图时,我在蓝图 markdown 中遇到了一个错误,该错误被标记为消息的语义问题:

第 21 行 - 忽略额外的响应标头,改为在引用的模型定义中指定此标头。

第 21 行是引用 [Cars][] 模型定义的行。我不想指定任何标题,我对这条消息试图指示我做什么感到困惑。任何人都可以阐明这个问题吗?

0 投票
0 回答
251 浏览

mocking - api blueprint mock data - 确保测试有效

我在一个项目的文档中采用了 API 蓝图,这很棒。我正在为一件可能很简单但我无法概念化的事情而苦苦挣扎:如何确保连接到共享数据库的 API 端点始终提供一组已知的数据?

我可以这样想象它:确保我的 HTTP 操作的顺序都是按顺序排列的,例如(伪代码,而不是实际的 api 蓝图语法):

POST /user {user_name: 'foo'}

返回{id:1}

GET /user/1

返回{user: 'foo'}

PUT /user/1 {user_name: 'bar'}

返回{id: 1}

DELETE /user/1

返回{delete: 'success'}

有没有其他人解决过这个问题,不幸的是,我无法确保 API 连接到的后端数据库的状态,这就是我面临这些不一致问题的原因。我们的一些团队一直在编写满足 GET 部分的文档规范,因为他们手动输入记录(例如,他们还没有创建 POST 逻辑)但是一旦我们切换后端数据库 GET user/1 并不总是返回“富”。希望这是有道理的,请让我知道我是否应该为清楚起见编辑我的问题。

0 投票
1 回答
452 浏览

node.js - 是否可以让 swagger ui 使用 API 蓝图规范?

我正在 node.js 上进行开发,目前正在使用 aglio 来预览我的 API Blueprint 降价文件。一切都很好,只是我无法测试 API。我喜欢http://petstore.swagger.wordnik.com/有办法测试 api,只是想知道 swagger 是否有办法接受 api 蓝图规范?

我试着环顾一下swagger docs,但我觉得也许我错过了它。

0 投票
1 回答
560 浏览

apiblueprint - API 蓝图资源定义无法正常工作

这个蓝图资源给我带来了问题。

如您所见,它是一个简单的获取请求,即http://my-host.com/api/v1/inboundSMS?number=123&message=hello%20world&key=SECRETKEY

但是,我从 apiary.io 收到错误消息

因为它是一个 GET 请求,所以没有消息体,所以我不知道为什么它抱怨它丢失了。

0 投票
1 回答
282 浏览

swagger - 是否可以从 Swagger 和/或 RAML 导入和/或导出 API 蓝图?

是否可以在任何格式之间架起桥梁?谢谢你。

0 投票
2 回答
962 浏览

apiblueprint - 如何创建嵌套模式?

目前该Schema定义根本没有记录,我能找到的唯一资源是这些:

http://support.apiary.io/knowledgebase/articles/147279-json-schema-validation https://github.com/apiaryio/api-blueprint/issues/112

但是这些示例都没有讨论如何创建嵌套模式。

我想验证这个回复:

根据我目前的知识,我已经开始创建看起来像这样的模式

但是如何为嵌套item和创建架构change

我可以使用哪些类型?

如何验证datetime?期望值为YYYY-MM-DD HH:MM:SS

0 投票
1 回答
881 浏览

apache-camel - apache camel中的spring&blueprint&router有什么区别?

我是保险丝的新手。我正在使用 Jboss Fuse 并创建 Fuse 项目。我想知道像spring、blueprint和router这样的容器之间的基本区别?

0 投票
1 回答
1095 浏览

facebook - 机器可读格式的 Facebook API

在哪里可以找到http: //swagger.io、https : //apiblueprint.orghttp://raml.org等格式的 Facebook API ?

我想阅读并请求 facebook 服务器(api)“半原子”。我的脚本知道如何与 facebook 服务器交互。这就是为什么我需要机器可读格式的 Facebook API。

谢谢你的任何提示。干杯托拜厄斯