SpringFox3系でドキュメント自動生成する

SpringFox

Springアノテーションからドキュメント生成できるSwagger拡張のSpringFox
設計情報の一覧としてはSpringFox(OpenAPI)のほうが見やすい感じがする。
→リソース単位でメソッドの一覧を表示してくれるので。

springfox2系が紹介されているブログは多かったのですが、最新の3系が紹介されている記事は少ないです。

springfox3系では面倒だった依存性、設定が簡単に記載できるようになっています。

依存性

springfox3系の依存性は次のとおり短くなっています。

Gradle
implementation "io.springfox:springfox-boot-starter:<version>"

Maven
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>

設定

springfox3では設定ファイルは不要です。

ソースコード

@Controller と @RestController のメソッドの設計書が自動生成されます。

設計書

設計書は次の場所に自動生成されます。

http://localhost:8080/swagger-ui/index.html

参考

springfox/springfox
Automated JSON API documentation for API's built with Spring - springfox/springfox