1

これが私のapibドキュメントのスニペットです。基本的に、リクエストとレスポンスのセクションの後に追加の説明情報を追加できるようにしたいのですが、この情報はレンダリングされません。代わりに、新しい見出しの下にあるそれ以降のテキストは、応答 200 セクションの一部として解釈されます。エラーセクションにテーブルを配置できるようにしたいので、このデータは理想的にはマークダウンレンダリングされます。これはアグリオで可能ですか？ありがとう！

#### 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 ブループリントリポジトリでチケットを開いて、そのような機能をリクエストするか、上記の回避策を使用することができます。

最後に 1 つ注意してください - 400 および 500 レベルの応答を要求/応答のペアとして記述できます。リクエスト/レスポンスのペアはドキュメントで指定された順序でレンダリングされるため、エラーの例が最後に表示されるようにすることができます。

于 2016-12-20T18:43:13.267 に答える