问题标签 [apiblueprint]

我已经安装了 Python、npm（全部添加到路径中）、VS 2013 并尝试安装名为 api-blueprint-preview 的 atom 包。

我的盒子运行的是 Windows 8.1。

有任何想法吗？谢谢！

我正在尝试为测试目的创建模拟 api 服务。我们已经在另一个团队中使用 Apiary，所以我从那里开始。

到目前为止，我注意到如果我想要两个单独的调用需要模拟两个请求。例如，要获取 id 为 1 和 2 的注释，需要明确写出如下响应：

/notes/1 /notes/2

有没有办法避免这种情况？诚然，我仍在努力创建蓝图。

我试图弄清楚如何描述/定义 POST/PUT 的请求正文属性/参数。这是我正在尝试做的一个示例，但我在文档中的任何地方都找不到它（我希望有一种方法可以查看任何公共 Apiary 文档的降价）：http://docs.bynder。 apiary.io/#reference/metaproperties/metaproperty-access/save-new-metaproperty

查看“请求”部分下的描述和属性定义？我怎么做？

我正在用 apiary/api 蓝图编写一些 API 定义。

有没有办法，对于相同的资源，我可以使用模拟端点根据输入来表现不同（或者失败，某种解决方法）？

例如，假设我有一个端点 /login，您应该向其发布用户名和密码。

如果我在 API 中设置成功登录的请求和响应，以及作为错误场景的后续请求和响应，则只有第一个会在模拟中触发。

因此，例如，如果我不发送用户名和密码，我仍然会收到登录成功的响应。

有没有办法让模拟做更多的验证，或者你如何解决这个问题？

谢谢

我有很多 API 端点要记录，POST 和 PUT 请求的负载可能很复杂。我正在用 apiblueprint 记录它们。我真的很喜欢 apiblueprint 允许我记录 URI 参数的方式。它看起来不错，可以让您向读者提供他们需要的所有信息，例如（必需、字符串或整数、列出选择/值并提供示例）。

当我们查看请求部分时，我没有看到如何提供相同级别的原始文档。我看到的请求部分只是提供了一个示例请求。

假设我们正在处理一个简单的有效负载，它只需要一个名为 id 的整数。目前我的请求部分看起来像这样，

标头

内容类型：应用程序/json

身体

{"id":"123"}

请求正文应该如此稀疏吗？向我的用户传达我的 REST 有效负载的所有约束/要求的最佳方式是什么？

我正在模拟一个肥皂网络服务，无论请求正文如何，我都只能返回默认的第一个响应。

我的尝试基于文档Multiple Transaction Examples并且我对自己做错了什么感到困惑。

举个例子：

在上面的示例中，即使我发布了两个不同的请求，我也只会收到第一个响应。根据链接的文档，这应该是可能的。

是否可以为 URI 参数定义验证？

• （即，，，，maxVal等minVal？maxLength）

如果没有，是否有任何好的解决方法至少记录参数的有效范围？

考虑以下两个资源之间的关系

• 学院有很多院系
• 教师属于一所大学

显然，教师不是这里的一流资源。

现在我需要端点来进行以下操作。

• 在这个农场的这所大学中创建一个新教师。在两个操作中执行此操作的一种可能方法。
  • POST /faculties/
  • PUT /college/1/faculties
• 从这所大学中删除一个教师。再次进行两次操作
  • GET /college/1/faculties: 相关院系列表。每个都将包含一个自我网址，例如/faculties/1.
  • DELETE /college/1/faculties/1: url 看起来更好但是如何暴露这个 url？
• 在该学院下添加一个或多个学院。
  • PUT /college/1/faculties接受这所大学学院的完整列表。
• 完全删除该特定扇区。
  • DELETE /sectors/1: 看起来不错，但需要照顾/faculties/1/sectors.

在这种情况下有什么更好的方法？我已经阅读过有关公开会员资源的信息，但是通过这种方法，如果一所大学有 10 个学院，则需要 10 次单独的 http 调用才能从会员中获取所有这些。

此外，这只是完整关系树的一小部分。为了进一步扩展这一点，假设系统有

• 学院有许多部门
• 部门有许多实验室等等。

此外，在 RESTful 架构中，客户端永远不应该填充 URL。

有什么建议吗？

我正在尝试使用 apiblueprint 来记录 API，但我遇到了一个错误（在第 31 行），上面写着“悬空的消息体资产，需要一个预先格式化的代码块，将它的每一行缩进 8 个空格或 2 个制表符”。仅在添加目录后，我才开始看到此错误。

如果我删除第 (34) 行“”，那么错误就消失了。可能是我在这里遗漏了一些东西，或者我可能不清楚。对它的任何帮助都是可观的。谢谢

下面是我的示例降价。

资源通常有多个 get 方法。通过查询参数获取单数或获取多个。这在蓝图中是如何表示的？我可以使用两种资源来做到这一点，但我认为这是不正确的，因为它是相同的资源。

与此问题相关，如何将 PUT 添加到给定 uri 的资源是在资源级别定义的。

理想情况下，这是我认为应该写的东西，但编辑不喜欢它。我在文档中发现 HTTP_ACTION 和 URI 可以放在一起，但编辑器似乎想要资源级别的 URI。