@int128

int128.hatenablog.com

Gradle Swagger Generator PluginがSwagger UI 3に対応

Gradle Swagger Generator Plugin 2.10.0をリリースしました。

github.com

新しいリリースではSwagger UI 3に対応しました。Swagger UI 3になってから使い勝手が大きく改善されています。

f:id:int128:20180309172132p:plain

このプラグインを利用すると、下記のようなビルドスクリプトを書くだけでAPIドキュメントを生成できます。APIドキュメントはS3やGitHub Pagesなどで簡単に共有できます。

// build.gradle
plugins {
  id 'org.hidetake.swagger.generator' version '2.10.0'
}

dependencies {
  swaggerUI 'org.webjars:swagger-ui:3.10.0'
}

swaggerSources {
  petstore {
    inputFile = file('petstore.yaml')
  }
}

これまでSwagger UI 2を使っていた方はビルドスクリプトの修正が必要になります。詳しくは2.10.0のリリースノートを参照してください。