Question

这是我的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

Answer 1

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 Blueprint解析器将您的文本视为属于响应而不是动作或示例，我无法在Aglio中修改该行为。您可以在上游API Blueprint存储库中打开票证以请求此类功能或使用上述解决方法。

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

请求/响应部分后的Aglio Render Markdown

1 个答案: