経緯
今、現場でSpringBoot使っているんだが、Swaggerのアノテーション使ってるところが話題にった。
そういえば、俺のSpringBootプロジェクトに導入してないな~って思って、API使って試したいこともあったので、ちょうどいいから導入してみようと思い、Swagger導入に至る。
導入方法
gradleを使っているんだが、build.gradleの dependencies
に下記の記述を追記。
// https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter implementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'
俺はgradleだったけど、下記のサイトから、環境に合わせた設定を選ぶ
https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter/3.0.0
設定が終わったら、更新してライブラリを落とし、SpringBootを再起動する。
したらば、下記のURLにアクセス
http://localhost:8080/swagger-ui/
自分はドメインをカスタマイズしてないので、URLは適時読み替えて。
感想
面倒な設定をせずに起動できるのが良かった。
APIのテストができるってのがいい。
導入が簡単なのがポイント高い。
設定は、気が向いたら凝るかも。