问题标签 [apiblueprint]

在为休息服务编写 API-Deocumentation 时，我遇到了一个问题，我想列出所有可能作为响应返回的值。

在下面的情况下，它将是“状态”字段，它可以包含任何可能的枚举值，我想总结一下存在哪些可能的状态。

我找不到使用 apiblueprint 的简单好方法。有没有办法显示默认折叠的部分并在需要其他信息时展开它们？

这是我的示例代码：

我需要参数部分的“值”之类的东西，但身体部分需要描述身体部分中的状态，例如

我试过了，但资源组有问题。我尝试创建一个自定义组“事件”并列出与事件相关的所有函数名称。

我正在关注文档中的示例，以了解语法及其工作原理。

所以我创建了这个 md 文件

在我运行 aglio 之后，我得到了一个漂亮的 html，但有一个问题。“{?limit}”也适用于 POST url。这真的很糟糕，找了好几个小时，无法理解如何绕过这个。

我们正在构建的 API 允许用户提供不同的请求主体。从我目前所见/发现的情况来看，每个动作/资源只能提供一个请求。是否可以指定不同的请求主体？

我试过这样：

并且还喜欢：

我有一个返回字符串数组（即不是对象）的 REST 服务。Apiary 的相关蓝图降价如下：

当我在 Apiary 中运行模拟服务时，它可以工作，但在 apiary 流量检查器中出现以下错误：

有没有办法让它工作（对降价的更改），或者这是 Apiary 的错误？

apiary向我展示了如何向参数添加描述。但是，我需要的是对值进行描述。

例如 /users{?skills}。这个参数我有我自己的技能代码

'1' 表示会说英语

'2' 表示会游泳

'3' 表示可以开车

在参数描述之后添加它们是一种方法。如果我有技能代码的音调怎么办？而且这种方法的格式很难看。我怎样才能实现它？

我正在寻找一种有效的方法来从 Cloud Endpoint (Java) 生成的文件中生成可读格式的 API 文档。生成的文件是： - my_api.api - my_api*.discovery

看起来像这样的东西： - https://github.com/kevinrenskers/raml2html#example-output

Swagger、API blueprint 和 RAML 都是不错的选择，但似乎不能很好地适应端点生成的 API 描述符文件。

你使用什么方法？

人们如何使用 API 蓝图管理多个 API 版本？

该格式似乎不支持单个文件中的版本部分，因此我认为文件名中带有指示符的多个文件是最佳选择。

我们希望利用这些工具来创建一个中央模拟服务器和文档公共资源，并且需要处理每个 API 的多个版本的演变。

假设我创建了一个资源，POST /resource并在响应正文上产生一个id，然后我用它id来检索我的资源GET /resource/{id}。

如何将这两个请求放在同一个 API 蓝图组中？

显然，一个组只有一个端点，这使得以下看起来您将创建一个POST /resource/{id}不正确的资源，因为此时您甚至没有 id。

我查看了示例，但找不到创建和检索特定资源的示例。我这样做是错误的吗？

有没有办法为 URI 参数的可能值添加描述？

如果我使用上面给出的方法，那么我不能定义example和default值（例如，4），因为它需要完整的值（4 - date）。