【Rails】committee-railsとRSpecでOpenAPIのスキーマチェックをする方法

group :development, :test do
  gem 'committee-rails', '~> 0.8.0'
end

RSpec.configure do |config|
  # 他の設定は省略します

  # OpenAPIのスキーマチェックを行う
  config.include Committee::Rails::Test::Methods
  config.add_setting :committee_options
  config.committee_options = {
    # API定義ファイルのパスを指定する
    schema_path: Rails.root.join('docs/openapi/openapi.yaml'),
    strict_reference_validation: true,
  }
end

class Api::V1::TodosController < ApplicationController
  def index
    @todos = Todo.all.order(:id)
    render json: { todos: @todos }
  end
end

require 'rails_helper'

RSpec.describe "Api::V1::Todos", type: :request do
  describe "GET /index" do
    it "returns http success" do
      get "/api/v1/todos"
      expect(response).to have_http_status(:success)
    end

    it "returns a list of todos" do
      todo = Todo.create(title: "Test Todo", done: false)
      get "/api/v1/todos"
      expect(response).to have_http_status(:success)
      expect(response.body).to include(todo.title)
    end

    it "returns a list of todos in the correct order" do
      todo1 = Todo.create(title: "Test Todo 1", done: false)
      todo2 = Todo.create(title: "Test Todo 2", done: false)
      get "/api/v1/todos"
      expect(response).to have_http_status(:success)
      expect(response.body).to include(todo1.title)
      expect(response.body).to include(todo2.title)
      expect(response.body.index(todo1.title)).to be < response.body.index(todo2.title)
    end

    # リクエストがOpenAPI定義に準拠しているかテスト
    it 'conforms to request schema' do
      get '/api/v1/todos'
      assert_request_schema_confirm
    end

    # レスポンスがOpenAPI定義に準拠しているかテスト
    it 'conforms to response schema with 200 response code' do
      get '/api/v1/todos'
      assert_response_schema_confirm(200)
    end
  end
end