问题标签 [apiblueprint]

我浏览了 Apiary 的文档，但没有找到如何创建蓝图来更新资源。

我在这里尝试实现的是一个简单的场景，例如拥有一个用户列表，能够列出它们，通过 id 检索单个用户，为该用户定义不同的属性，修改该用户的一个 n 属性（更新用户），并删除该用户。

有人可以将我重定向到一些清晰的文档或我在研究期间错过的 stackoverflow 问题，这将帮助我实现这一目标吗？

过去几天我一直在试图了解是否应该使用 api blueprint、RAML 或 swagger。

看起来 swagger 拥有最大的社区，但我越看越觉得它在文档方面非常缺乏（我被迫多次查看代码以尝试将其与我当前的项目集成），许多 github 问题和 stackoverflow问题没有答案。

我有可能在这里遗漏了什么吗？我想要的只是一个工具来帮助我编写 API 文档和测试端点。

为什么大摇大摆必须成为服务器逻辑的一部分？如果我在编辑器中创建 swagger 文件，然后直接将它们提供给UI，它会中断..

据我所知，它甚至使服务器稍微慢了一点，并迫使存在许多笨拙地维护的集成：p 我在这里错过了什么？

I want to search (say) "accounts" based on "name" or "status".

So I would like to have two actions :

• GET /persons/?q=name==Jea*
• GET /persons/?q=status==locked

How can I document that ?

I tried an Action with multiples transactions :

But Apiary editor complains because :

1. I must provide a message-body for my GET requests:

   Message-body asset is expected to be a pre-formatted code block, every of its line indented by exactly 8 spaces or 2 tabs.

2. The + Parameters block is not recognized :

   Ignoring unrecognized block

Thanks a lot

http://apiblueprint.org/#get-started上示例的结构似乎与 APIary.io 上的结构不同。

任何人都可以评论它们是否不同，如果是，哪种结构是正确的？

例如，

API 蓝图文档结构

1.) 元数据 2.) API 名称和概述 3.) 资源 A.) URI 参数 B.) 模型 1.) 标头 2.) 正文 3.) 模式 C.) 操作 1.) URI 参数 2.) 请求.) 标题 b.) 正文 c.) 架构 3.) 响应 a.) 标题 b.) 正文 c.) 架构 4.) 资源组 A.) 资源

相对

非常感谢，

为了说明我的问题，我从 Apiary.io 蓝图教程中制作了一个精简示例。

然后在我的养蜂场文档中，我得到以下信息：

since但是，对我来说，仅将查询参数用于 GET 请求是有意义的。不幸的是，我没有找到实现此结果的方法：

有可能吗？

问题：

我正在搜索 Java 或 JavaScript（或者可能是 Scala）中的库，它能够生成 Swagger、RAML 或 API 蓝图输入的 HTML 表示。

背景：

这个想法是将其用作（Play Framework）网络应用程序的一部分，用作 API 目录。API 规范将由 API 目录的用户添加，并生成/显示生成的 HTML 表示。

如果 API 规范存根也可以使用 Java API 创建，这将提供额外的价值。API 目录 Web 应用程序有一个数据模型，我想在生成 API 存根时使用它。

此外，如果同一个（或相关的另一个）库提供了一个很好的 API 规范语言（Swagger、RAML、API 蓝图等）的 HTML 编辑器，在编辑时支持用户，它将提供额外的价值。

我正在尝试编写一个 API，并努力寻找一种向资源添加自定义操作的好方法。例如，在我的 User 资源中，我想要操作enabled和disable，但在通常的蓝图分组中，我无法在组下添加这些：

在这里，Disable a UserandUpdate a User都指向同一个 URL，这不是我想要的。我希望这些分别产生 URL/users/{id}和/users/{id}/disable。

查看其他 API 源，其他人在不使用命名资源的情况下完成了它，这将给出：

虽然我可以使用这种方法，但我更喜欢使用第一种方法，因为它在被大多数蓝图工具渲染时更清晰。

有没有一种方法可以使用第一种方法进行自定义操作，或者其他人是否有更清洁的方法来实现相同的事情

https://github.com/apiaryio/redsnow
https://github.com/apiaryio/matter_compiler

我需要为 matter_compiler 生成一个带有 redsnow 的 json/yaml。
我检查了文档和代码，但没有找到。目前有可能吗？

为什么需要它：
我想使用来自测试/规范的数据生成 apiblueprint-markdown。

In my blueprint, I have an action parameter for the GET action that is defined as a required parameter. However when I invoke the mock service endpoint without the parameter I get a legal response. Is there any runtime enforcement corresponding to the defined action parameter constraints?

我正在尝试将一个简单的 json 对象从 iOS 发送到养蜂场服务器。我在创建它后打印出我的 json 对象，一切看起来都很好。但是养蜂场把一切都搞混了。如果我只有一个项目，那么它看起来不错。

在这里我创建对象并对其进行编码

接下来我使用 AFNetworking 发送数据

记录我得到的解码的 json 对象

最后，在养蜂场我得到以下信息

json都混在一起了。我不确定 AFNetworking 是罪魁祸首还是 apiary 混合了它，我不应该担心它，因为真正的服务器不会有这个问题。

最后，这是我设置养蜂场的方式

有人看到我在做什么可疑的事情吗？谢谢

哦，除了混淆之外，json还有重复的数据。