Spring Boot でSwagger を使う方法

Spring Boot でSwagger を使う方法

Swaggerを使うにはbuild.gradleに以下2行を追加します。

コンフィグファイル作成

SwaggerConfig.java(ファイル名は任意)というファイルを作成します。

@EnableSwagger2アノテーションを忘れずにつけます。

必要に応じてSwaggerConfigに対するプロパティファイルを作成します。(特に不要ですが)

ここでは、SwaggerProperties.javaとします。

コントローラー

GETとPOSTのRestControllerを作成します。

Spring Bootアプリケーションを実行して、http://localhost:8080/swagger-ui.htmlにアクセスすると、SwaggerのHTML画面が表示されます。

Spring Boot でSwagger を使う方法

サンプルAPIの下にあるリンクをクリックするとapi-doc.jsonがダウンロードされます。

参考サイト

buid.gradleでapiclientを自動生成する

build.gradleのタスクを作成してswagger codegenよりsdkを自動生成することが可能です。

build.gradleに以下のタスクを追加します。

これでタスクを実行すればbuild配下にプロジェクトが生成されます。

springdoc-openapi

https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui

springdoc-openapi

バージョン3からOpen APIと名称が変わったようです。springdoc-openapi-uiライブラリを使用してAPIドキュメントを生成します。

build.gradleに以下1行を追加します。

Spring Bootアプリケーションを実行して、http://localhost:8080/swagger-ui.htmlにアクセスすると空のAPIドキュメント(Swagger UI)が表示されます。

Spring Boot でSwagger を使う方法

applicaion.yml

パスの変更やSwagger UIの無効化など、いくつか設定変更することが出来ます。

これで、http://localhost:8080/aaa.htmlでSwagger UIにアクセスできるようになります。

JSONのパスを/hogeに変更します。http://localhost:8080/hogeでJSONにアクセスすることが出来るようになります。

Spring Boot でSwagger を使う方法

  • このエントリーをはてなブックマークに追加
  • Evernoteに保存Evernoteに保存

コメントをどうぞ

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA