How to write an external tool for `git diff` to delegate complex diffs to.
How to configure `git diff` to use `oasdiff`'s rich changelog on changes to OpenAPI specs.
タイトルにあるようにSwaggerで作成したいのであれば、yamlを作成すればいい。
だけど、そんなことをするのは面倒くさい。
というのもNestJsではデコレーターを追加するだけで自動でSwagger UIを作成してくれた。
そこでGoでも同様な手順で実現できるライブラリを探してみた。
swaggo/swag
swaggo/swagを使えばできそうだったので試してみた。
インストール
アノテーションを作成する
main.goにアノテーションを追加する。
記入後にswag initを実行する。
すると上記ファイルたちが生成される。
UIで確認する
これがいまいちわかなかったので、https://editor.swagger.io/に生成されたyamlファイルをコピペして見る方法にしているけど、localhost:18080/api/v1で見られるんだと思われる。
…
依存関係をインストールする
main.tsを編集する
後は上の記述を編集し、http://localhost:3000/api/を開けば作成されている。
非常に楽なので活用していきたい。
APIをグルーピングする
これだとcatsというタグができるがその中は空になり、すべてがdefaultにグルーピングされる。
任意のグルーピングを作りたい時は、hoge.controller.tsを下記のように変更する。
これで意図した形になる。
Page 1