Spring REST Docs とは？ - 概要・学習

Spring REST Docs は、RESTful サービスをドキュメント化できます。

Asciidoctor (英語) で書かれた手書きドキュメントと Spring MVC テストで作成された自動生成スニペットを組み合わせています。このアプローチにより、Swagger (英語) のようなツールによって生成されるドキュメントの制限から解放されます。

これは、正確で簡潔で、適切に構成されたドキュメントを作成できます。このドキュメントにより、ユーザーは最小限の手間で必要な情報を取得できます。

Spring Boot 構成

Spring Boot は、テストで Spring REST Docs を活用する @AutoConfigureRestDocs アノテーションを提供します。

Spring Initializr (英語) を使用してアプリケーションをブートストラップします。

各 Spring プロジェクト別に用意されています。プロジェクトの機能を使用する方法と、それを使用して達成できることを詳細に説明しています。