Aglio 在请求/响应部分之后呈现 Markdown

Question

这是我的 apib 文档的片段。本质上，我希望能够在请求和响应部分之后放置额外的描述信息，但是这些信息不会呈现。相反，新标题下的任何其他文本都被解释为响应 200 部分的一部分。我希望能够在错误部分放置一个 table，因此该数据最好是降价呈现。这可能与 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

Answer 1

Cameron，这目前只能在 request/response 对之前的描述部分中实现。例如：

## 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)

或者，您可以在自定义模板中对此类信息进行硬编码，这样您就可以完全控制内容的去向。我之所以说 "hard code" 是因为 API 蓝图解析器将您的文本视为属于响应而不是动作或示例，我无法在 Aglio 中修改该行为。您可以在上游 API Blueprint 存储库中打开票证以请求此类功能或使用上述解决方法。

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

Aglio 在请求/响应部分之后呈现 Markdown

Aglio Render Markdown after Request / Response section

apiblueprint

aglio