swaggerからOpenApi GeneratorでSpringのコードを自動生成

OpenApi Generatorでコードを自動生成

OpenApi Generatorはswaggerから自動生成できてとても便利なのですが、色々設定が面倒そうで後回しになっていました。
今回使ってみたら意外に簡単だったので、記事にしておきました。

docker image

今回、調べてみるまではOpenApi generatorはgithubからプロジェクトをpullしてmavenでビルドして・・・という風に面倒なイメージがありましたが、dockerを利用すると簡単にswaggerからコードを自動生成できるようでした。
使い方はswaggerの置いてあるディレクトリまで移動して以下のコマンドを実行します。(swaggerファイル名はswagger.yamlとしております)

$ docker run --rm -v $PWD:/local \
  openapitools/openapi-generator-cli generate \
  -i /local/swagger.yaml \
  -g kotlin-spring \
  --additional-properties useBeanValidation=true \
  -o /local/out 

使用しているオプション

• -i -> 使用するswaggerファイルを指定
• -g -> 生成するファイルを指定(今回はkotlin-spring)
• --additional-properties useBeanValidation -> バリデーションを付与(他にもいろいろパラメータがあるようです)
• -o -> 出力先のフォルダを指定

すごい簡単でした・・・
他にも色々カスタマイズできるようなので、色々試してみたいですね。

参考

こちら、参考にさせていただいた資料です。
平静を保ち、コードを生成せよ
openapi-generator docker