読者です 読者をやめる 読者になる 読者になる

GeekFactory

int128.hatenablog.com

Gradle Swagger Generator Plugin 1.5.1 has been released

gradle swagger

Gradle Swagger Generator PluginでSwagger UIを生成できるようになりました。

以下のビルドスクリプトgenerateSwaggerUI タスクを実行すると、 build/swagger-ui フォルダにSwagger UIが出力されます。

plugins {
  id 'org.hidetake.swagger.generator' version '1.5.1'
}

repositories {
  jcenter()
}

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

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

利用シーン

swagger2markupのHTMLドキュメントだけでは読みづらいので、Swagger UIを併用するとよいでしょう。例えば、以下の使い方が挙げられます。

  1. generateSwaggerDoc タスクでHTMLドキュメントを生成する。
  2. generateSwaggerUI タスクでSwagger UIを生成する。
  3. それらをGitHub Pagesに載せて、開発チームが参照できるようにする。

Gradle Swagger Generator Pluginは下記リポジトリで公開しています。

github.com