Spring BootでOpenAPI Swaggerを有効にしてアクセスする方法

2024-02-09 14:52 Spring Boot OpenAPI Swagger
  1. 依存関係の追加: まず、プロジェクトの依存関係にSwagger関連のライブラリを追加します。以下の依存関係を pom.xml ファイルに追加してください。
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.5.12</version>
</dependency>
  1. Swaggerの設定: application.properties ファイルにSwaggerの設定を追加します。以下の設定を追加してください。
# Swagger設定
springdoc.swagger-ui.path=/swagger-ui.html
  1. Swaggerの使用: Swaggerを使用するために、APIのコントローラークラスにSwaggerのアノテーションを追加します。以下は、例としてUserControllerクラスにSwaggerのアノテーションを追加する方法です。
@RestController
@Tag(name = "User API", description = "ユーザーに関するAPI")
public class UserController {
    @Operation(summary = "ユーザーの取得", description = "指定されたIDのユーザーを取得します")
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable Long id) {
        // ユーザーの取得ロジック
    }
// 他のAPIメソッドも同様にSwaggerのアノテーションを追加してください
}
  1. アプリケーションの起動: Spring Bootアプリケーションを起動し、以下のURLにアクセスしてSwagger UIを表示します。
http://localhost:8080/swagger-ui.html

以上の手順を実行すると、Spring BootでOpenAPI Swaggerを有効にしてアクセスすることができます。Swagger UIを使用すると、APIエンドポイントのドキュメントを表示し、APIのテストも行うことができます。