SpringDoc OpenAPI

URL

springdoc:
  api-docs:
    enabled: true 
    path: /api-docs 
  swagger-ui:
    enabled: true 
    path: /swagger-ui.html

アノテーション

Swagger から SpringDoc OpenAPI への移行

SpringFox 注釈(ちゅうしゃく)	SpringDoc 注釈(ちゅうしゃく)	位置(いち)	説明(せつめい)
`@Api(tags = "...")`	`@Tag(name = "...")`	Controller クラス	API をグループ分けします
`@ApiOperation(value = "...")`	`@Operation(summary = "...")`	Controller メソッド	API の概要(がいよう) を記述(きじゅつ)
`@ApiOperation(notes = "...")`	`@Operation(description = "...")`	Controller メソッド	API の詳細(しょうさい) を記述(きじゅつ)
`@ApiParam`	`@Parameter`	メソッド引数(ひきすう)	引数名(ひきすうめい) 、必須(ひっす) 、例(れい) など
`@ApiIgnore`	`@Hidden`	クラス/メソッド	ドキュメントから隠(かく) す
`@ApiModel`	`@Schema`	モデルクラス	モデルの定義(ていぎ)
`@ApiModelProperty`	`@Schema`	モデルフィールド	属性(ぞくせい) の意味(いみ) や例(れい)
`@ApiResponse(code = 200)`	`@ApiResponse(responseCode = "200")`	メソッド	レスポンスの意味(いみ)
`@RequestParam`	`@Parameter(in = QUERY)`	メソッド引数(ひきすう)	クエリパラメータ
`@PathVariable`	`@Parameter(in = PATH)`	メソッド引数(ひきすう)	パス変数(へんすう)

Import パスの対照

SpringFox (旧(きゅう) )	SpringDoc (新(しん) )
`io.swagger.annotations.Api`	`io.swagger.v3.oas.annotations.tags.Tag`
`io.swagger.annotations.ApiOperation`	`io.swagger.v3.oas.annotations.Operation`
`io.swagger.annotations.ApiModel`	`io.swagger.v3.oas.annotations.media.Schema`
`io.swagger.annotations.ApiResponse`	`io.swagger.v3.oas.annotations.responses.ApiResponse`

依存関係の変更

<!-- SpringFox を削除し、こちらを注入 -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.x.x</version>
</dependency>

コードサンプル

SpringDoc OpenAPI (新(しん) しい方式(ほうしき) )

@Configuration
public class OpenAPIConfig {
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("API ドキュメント")
                        .description("詳細説明")
                        .version("1.0.0"));
    }
}

注意点

SpringDoc は @EnableSwagger2 などを 必要としません。
Swagger UI のデフォルトパスは /swagger-ui/index.html です。
JSON パスは /v3/api-docs です。

Spring Scheduling Thymeleaf