Spring Boot3でswagger-uiを表示させる

Spring BootでRESTFul APIを作成する際に、swagger-uiを用いてリクエストのテストをすることができます。

今回はこちらの設定方法について確認をしていきます。

設定ファイルを編集する

pox.xmlの場合

Mavenで作成されたプロジェクトの場合、pox.xmlに以下の設定を追加します。

<dependency>
　　<groupid>org.springdoc</groupid>
　　<artifactid>springdoc-openapi-starter-webmvc-ui</artifactid>
　　<version>2.1.0</version>
</dependency>

gradle.buildの場合

Gradleで作成されたプロジェクトの場合、gradle.buildに以下の設定を追加します。

dependencies {
    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.0'
}

swagger-uiで表示する

サーバを起動してswagger-uiにアクセスします。

なお、デフォルトではブラウザでhttp://localhost:8080/swagger-ui.htmlへアクセスすれば、操作画面を表示することができます。