1

spring-restdocs を使用して API ドキュメントを生成しています。すべてのパラメーター、パス、応答フィールドの JSON パスをテーブル内のコード セクション (Asciidoc のバックティック) として出力したいと考えています。

たとえば、JSON パス sprockets.[].widgets.[].contentType はsprockets.[].widgets.[].contentType、モノスペースで印刷された よりも可変幅フォントで読みにくくなります。

リクエスト パラメータとパス パラメータについても同じことが言えます。これらはモノスペースで出力する必要があるトークンです。

Spring-restdocs でこれを達成する最も簡単な方法は何ですか?

助けてくれてありがとう。

G

4

2 に答える 2

2

REST Docs はデフォルトでこれを行うべきだと思います。1.1 で修正される問題をオープンしました: https://github.com/spring-projects/spring-restdocs/issues/230。提案をありがとう。

それまでの間、カスタム スニペット テンプレートを使用して、必要なことを行うことができます。たとえば、リクエスト フィールドのパスのフォーマットをカスタマイズするには、次のようなrequest-fields.snippetファイルを提供する必要があります。src/test/resources/org/springframework/restdocs/templates

|===
|Path|Type|Description

{{#fields}}
|`{{path}}`
|{{type}}
|{{description}}

{{/fields}}
|===

の周りのバッククォートに注意してください{{path}}。

于 2016-05-10T14:59:04.190 に答える
0

モノスペースの「m」などの asciidoctor フォーマット コードを使用することもできます。

m|{{path}}

列の幅と配置を変更することもできます。たとえば、相対的な幅が 4-4-2 の 3 つの列と、3 番目の列が中央に配置されています。

[cols="2*4,^2"]
|===
|Parameter|Description|Optional

（それはあなたが求めたものではないことは知っていますが、asciidoc を初めて使用する spring-restdocs ユーザーにとっては、カスタマイズのための簡単なオプションがたくさんあることを知っておくと役立つかもしれません）

http://asciidoctor.org/docs/user-manual/#cols-formatを参照してください

于 2016-05-24T07:58:04.443 に答える