1

这是我的 apib 文档的片段。本质上，我希望能够在请求和响应部分之后放置其他描述性信息，但是不会呈现此信息。相反，新标题下的任何其他文本都被解释为响应 200 部分的一部分。我希望能够在错误部分中放置一个表格，因此理想情况下这些数据将被降价渲染。用 aglio 可以吗？谢谢！

#### Rate Limiting

This endpoint allows 20 requests per hour.

+ Request (application/json)
    + Attributes (object)
        + id (number)

+ Response 200 (application/json)
    + Attributes (object)
        + status: success (string)

### Errors

Table of error codes
4

1 回答 1

0

Cameron，目前这只能在请求/响应对之前的描述部分中实现。例如：

## My Resource [/foo]

### My Action [GET]

#### Rate Limiting

This endpoint allows 20 requests per hour.

#### Errors

Table of error codes

+ Request (application/json)
    + Attributes (object)
        + id (number)

+ Response 200 (application/json)
    + Attributes (object)
        + status: success (string)

或者，您可以在自定义模板中对此类信息进行硬编码，这样您就可以完全控制信息的去向。我说“硬代码”的原因是因为 API 蓝图解析器将您的文本视为属于响应而不是操作或示例，并且我无法在 Aglio 中修改该行为。您可以在上游API 蓝图存储库上打开一个工单以请求此类功能或使用上述解决方法。

最后一点 - 您可以将 400 和 500 级响应描述为请求/响应对。由于请求/响应对是按照文档中给出的顺序呈现的，因此您可以确保错误示例最后显示。

于 2016-12-20T18:43:13.267 回答