SwaggoでOpenAPIに対応した話
経緯
APIを公開する急ぎの予定はないけど、APIのセキュリティスキャンを実施したかったので、swaggerを書く必要ができた。べた書きするのも嫌なので、色々調べてたらswaggoに出会った
Swaggo
goで書かれたwebAPIのswaggerを/docsに配置してくれる
Swaggoの使い方
ローカルとプロジェクトにインストール
go install github.com/swaggo/swag/cmd/swag@v1.8.7
go get github.com/swaggo/echo-swaggermain.goを書き換える
ハンドラーを書き換える
swaggerを初期化
swag initそすると、http://localhost:8080/swagger/にswaggerができてる!!
まとめ
色々めんどくさいswaggerですが、簡単にできましたね。どんどん楽していきましょう。
余談ですが、仕事で使ってるPythonのFastAPIは自動で、swaggerを生成してhostしてくれます。golangは強力な構文解析能力があるので、いつかこういうライブラリも表れてくれそうですね