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配下にプロジェクトが生成されます。

スポンサーリンク
  • このエントリーをはてなブックマークに追加
スポンサーリンク

コメントをどうぞ

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

CAPTCHA