問題タブ [spring-auto-restdocs]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
asciidoc - Spring Auto Rest Docs はすべての Json サブタイプを文書化します
顧客の残高とトランザクションを取得するために、/balance と /transactions の 2 つのオペレーションを持つ Rest サービスがあります。
この操作の戻り値の型は BalanceResponse と TransactionResponse であり、これらの型は両方とも Response から拡張されています
/balance サービス操作の文書化では、2 番目のサブタイプ (TransactionResponse) にも応答フィールドがリストされています。
戻り値の型に対応するフィールドのみを表示する方法は? /balance の場合は (ステータス、残高、制限) が表示され、/transaction のみの場合は (ステータスとトランザクションのリスト) が [Response] フィールドに表示されます。
誰かがドキュメントで基本的に継承タイプを処理する方法を教えてください
以下のコード スニペットと自動 RestDoc 生成ドキュメントを見つけてください。
ここに画像の説明を入力しますAuto RestDoc Response フィールド
spring-auto-restdocs - Spring Auto Rest Docs の Auto Section タイトル レベル
これは StackOverflow に関する私の最初の質問です。
Java 11、Spring Boot 2.4.0、JUnit 5、Auto Rest Docs 2.0.9 を使用しています。
ドキュメントの生成中に次の警告が表示されます。
asciidoctor: WARNING: C:/{path-to-project}/build/generated-snippets/register_success/auto-section.adoc: line 2: section title out of sequence: expected level 2, got level 3
2 行目は次のようになります。==== Register
ドキュメントの構造は次のようになります。
内に直接含まれるすべてのスニペットに対して警告がありますLevel 1 section。
内部のスニペットについては、Level 2 sectionすべて問題ありません。
警告が表示される理由は理解できますが、自動生成されたスニペット内でタイトル レベルを構成するにはどうすればよいですか?
セクション タイトルがレベル 2 になるように設定する方法があれば、Level 2 section(のようなexpected level 3, got level 2) 内のスニペットに対して警告が表示される可能性があります。
自動生成されたスニペット内のセクション タイトルのレベルを自動的に設定する方法はありますか? (含まれる親セクション レベルに基づく)
または、各単体テスト内で意図するレベルを指定する方法さえあります。
ドキュメントを確認しましたが、何も見つかりませんでした。どんな助けでも大歓迎です。ありがとうございました！
java - Spring REST Docs + RequestBody + フィールドの深いレベルのドキュメント化を防止
Spring REST Docs に問題があり、リクエスト本文内のフィールドの詳細なドキュメントを妨げています。
およびドキュメントのテスト:
このテストには多くの時間が必要で、出力は次のようになります。
root.childs[].childs[].childs[].childs[].childs[].childs[].path
どうすればこれを防ぐことができますか?