Rswag を使って RSpec から API ドキュメントを生成する

はじめに 以前 API ドキュメントはスプレッドシートや社内 Wiki で管理したりしていました。 最近だと OpenAPI Specification を使って書くことがほとんどです。 OpenAPI Specification とは RESTful な API を記述するための仕様で YAML と JSON 形式で記述できます。 形式はシンプルですが人力でやろうとすると、実装と乖離したり、間違いなどが必ず発生します。 今回の記事では実装と API ドキュメントが乖離しないようする方法の一つとして Rswag を使って RSpec から API ドキュメントを自動生成する方法について紹介したいと思います。 環境 Ruby: 3.2.2 Rails: 7.0.6 MySQL: 8.0 コード ライブラリ Rswag テストファーストな API 開発ができる gem です。 RSpec から