SpringFox は、Swagger と Spring フレームワークを統合するためのオープンソース プロジェクトであり、API ドキュメントを自動生成する機能を提供します。ただし、SpringFox プロジェクトは 2020 年に更新を停止し、後継の SpringDoc に置き換えられました。したがって、古いバージョンの SpringFox を使用している場合は、より良いサポートと最新の機能を得るために、SpringDoc に移行するのが賢明な選択です。
SpringFox と Swagger 2 の依存関係を削除し、代わりに springdoc-openapi-starter-webmvc-ui の依存関係を追加します。
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.1.0</version>
</dependency>
Swagger 2 アノテーションを Swagger 3 アノテーション (springdoc-openapi-starter-webmvc-ui 依存関係に含まれる) に置き換えます。Swagger 3 アノテーションのパッケージ名は io.swagger.v3.oas.annotations です。
- @アピ → @タグ
- @ApiIgnore → @Parameter(hidden = true) または @Operation(hidden = true) または @Hidden
- @ApiImplicitParam → @Parameter
- @ApiImplicitParams → @Parameters
- @ApiModel → @スキーマ
- @ApiModelProp