タグ

Swaggerに関するmziyut112のブックマーク (1)

  • GithubActionsでSwaggerドキュメントを自動更新して、PRへコメントをつける - Qiita

    はじめに いくつかのプロジェクトにてSwaggerを利用した、API仕様書の運用をしています。 エンドポイントの追加・変更などがあった場合に、ドキュメントの更新を忘れがちなので、github上でPRを作成した際に、swaggerドキュメント生成のためのコマンドを自動実行し、差分があった場合はPR上にコメントするようなフローを作成しました。 使用言語及びライブラリは以下。 https://github.com/swaggo/gin-swagger 前提として、DockerfileやMakefile等でSwaggerドキュメントの生成ができている状態とします。 (各種ライブラリなどで設定方法・実行方法は違うと思うので、Swaggerの設定部分については割愛します。) 実行ファイル 全体の設定ファイルです。以下で一つ一つ見ていきます。 PRのオープン・プッシュのイベントでトリガーされます。 na

    GithubActionsでSwaggerドキュメントを自動更新して、PRへコメントをつける - Qiita
  • 1