はじめに いくつかのプロジェクトにてSwaggerを利用した、API仕様書の運用をしています。 エンドポイントの追加・変更などがあった場合に、ドキュメントの更新を忘れがちなので、github上でPRを作成した際に、swaggerドキュメント生成のためのコマンドを自動実行し、差分があった場合はPR上にコメントするようなフローを作成しました。 使用言語及びライブラリは以下。 https://github.com/swaggo/gin-swagger 前提として、DockerfileやMakefile等でSwaggerドキュメントの生成ができている状態とします。 (各種ライブラリなどで設定方法・実行方法は違うと思うので、Swaggerの設定部分については割愛します。) 実行ファイル 全体の設定ファイルです。以下で一つ一つ見ていきます。 PRのオープン・プッシュのイベントでトリガーされます。 na
![GithubActionsでSwaggerドキュメントを自動更新して、PRへコメントをつける - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/a0435c23c56ef3e9463e1f58a3e179a465ea7f91/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-9f5428127621718a910c8b63951390ad.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZoPTMzNiZ0eHQ9R2l0aHViQWN0aW9ucyVFMyU4MSVBN1N3YWdnZXIlRTMlODMlODklRTMlODIlQUQlRTMlODMlQTUlRTMlODMlQTElRTMlODMlQjMlRTMlODMlODglRTMlODIlOTIlRTglODclQUElRTUlOEIlOTUlRTYlOUIlQjQlRTYlOTYlQjAlRTMlODElOTclRTMlODElQTYlRTMlODAlODFQUiVFMyU4MSVCOCVFMyU4MiVCMyVFMyU4MyVBMSVFMyU4MyVCMyVFMyU4MyU4OCVFMyU4MiU5MiVFMyU4MSVBNCVFMyU4MSU5MSVFMyU4MiU4QiZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTU2JnR4dC1jbGlwPWVsbGlwc2lzJnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnM9ZjJkZTJkODlmMTg3ZGRmOGFiYTA1MzJmMmYyZjI5MDI%26mark-x%3D142%26mark-y%3D112%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTcxNiZ0eHQ9JTQwcHBjbyUyMGluJTIwJUU2JUEwJUFBJUU1JUJDJThGJUU0JUJDJTlBJUU3JUE0JUJFTElGVUxMJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9MzImdHh0LWFsaWduPWxlZnQlMkN0b3Amcz0wZjFlNGY0M2FjMDRkZmUzZGQzNTZjMGZhOTNjYWQ4Mw%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3Dcf85be355d7b6a5c414411046386de1d)