こんにちは。サーバサイドエンジニアをしている大堀です。 今回は、私が所属しているプロジェクトで導入しているSpring REST Docsによる、 API仕様書自動化方法に関して紹介します。 導入するに至った背景 私が今までのプロジェクトでは、APIドキュメントを手動で作成していましたが、 記入ミスや、時間が経つにつれて更新が滞ったり、実装と異なってくるという問題が生じていました。 そこで、Spring MVCの枠組みで作成されたアプリケーションから、 自動でドキュメントを生成してくれるSpring REST Docsを導入することにしました。 Spring REST Docsについて Spring REST DocsはRESTfulなサービスのドキュメントを生成するツールです。 Spring MVC Testで書かれたテストを通った場合、HTTPリクエストやレスポンス等が記載されたsni