Spring REST Docs
2.0.5.RELEASESpring REST Docs は、RESTful サービスをドキュメント化できます。
Asciidoctor (英語) で書かれた手書きドキュメントと Spring MVC テストで作成された自動生成スニペットを組み合わせています。このアプローチにより、Swagger (英語) のようなツールによって生成されるドキュメントの制限から解放されます。
これは、正確で簡潔で、適切に構成されたドキュメントを作成できます。このドキュメントにより、ユーザーは最小限の手間で必要な情報を取得できます。
Spring Boot 構成
Spring Boot は、テストで Spring REST Docs を活用する @AutoConfigureRestDocs
アノテーションを提供します。
ドキュメント
各 Spring プロジェクト別に用意されています。プロジェクトの機能を使用する方法と、それを使用して達成できることを詳細に説明しています。
2.0.5.RELEASE CURRENT GA | リファレンスドキュメント (英語) | API ドキュメント (英語) |
2.0.6.BUILD-SNAPSHOT SNAPSHOT | リファレンスドキュメント (英語) | API ドキュメント (英語) |
1.2.7.BUILD-SNAPSHOT SNAPSHOT | リファレンスドキュメント (英語) | API ドキュメント (英語) |
1.2.6.RELEASE GA | リファレンスドキュメント (英語) | API ドキュメント (英語) |
例を試してみる:
- Spring HATEOAS Spring HATEOAS を使用して実装されたサービスの入門ガイドと API ガイドの作成を示します
- Spring Data REST Spring Data REST を使用して実装されたサービスの入門ガイドと API ガイドの作成を示します
- Web テストクライアントは、Spring WebFlux の WebTestClient での Spring REST ドキュメントの使用を示しています。
- スレート Spring REST Docs と Markdown および Slate の使用例を示します
- TestNG Spring REST Docs と TestNG の使用例を示します
- JUnit 5 は、JUnit 5 での Spring REST Docs の使用を示します