Swaggerを使って、APIドキュメントを手軽に作成しよう

APIドキュメントを手軽に作成できるツールであるSwaggerは、SpringBootでもサポートしております。

今回はSwaggerを使って、APIを作成してみましょう。

サンプルコードはこちらに上がっております。

1. 依存関係を追加する。

今回は、swagger をspringで使いやすくするためのツールである springfox を使いましょう。

依存関係に以下の二つのdependencyを追加します。

 

2. Swaggerの設定を行う

Swaggerの設定は、Docket クラスのBeanを作成することで設定可能です。

 

3. Swaggerを使ってみる

Swaggerを使ってみましょう。今回はサンプルコードの例に倣います。

localhost:{ポート番号}/swagger-ui.html にアクセスしてみましょう。swaggerの画面にアクセスできました。

Swagger上でAPIを試すこともできます。

コメントを残す

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