Committeeを導入してみた

5分間社内LT資料

Transcript

1. Committeeを導⼊してみた Kobayashi Yuta
2. Committeeとは APIがOpenAPIの定義と⼀致しているかどうかを確認することができるGemです。 Committeeを⽤いることで、実装とドキュメントの乖離を防ぐことが簡単にできます。
3. 設定 # rails_helper.rb RSpec.configure do |config| config.add_setting :committee_options config.committee_options = { schema_path: Rails.root.join("docs", "openapi.v1.yaml").to_s } config.include Committee::Rails::Test::Methods end 他にも細かい設定が可能ですが、デフォルトの設定を利⽤しています。 https://github.com/interagent/committee
4. 使い⽅ describe "GET /" do it "conforms to request schema" do assert_request_schema_confirm end it "conforms to response schema" do assert_response_schema_confirm end end
5. 注意点1 このようにレスポンスステータスを確認しないと、意図していないレスポンスのテストをして いる可能性がある。 RSpec.describe "V1::UsersInformation", type: :request do let(:user) { create(:user) } describe "GET /v1/users/me" do it "conforms to response schema of success" do get v1_user_information_index_path, headers: @headers assert_response_schema_confirm expect(response).to have_http_status 200 end it "conforms to response schema of failure" do get v1_user_information_index_path assert_response_schema_confirm expect(response).to have_http_status 401 end end end
6. 注意点2 ネストしているオブジェクトのスキーマをチェックする場合、requiredになっていないオブジ ェクトを正しくチェックできません。
7. 実際に使ってみて これだけでも本当に開発がスムーズになります。 実装か定義のどちらかが間違っていた場合、即座に気づけるためフロントと繋いでみた結果、 定義に沿っていなくてエラーになるということが無かったです。 また、何かしら仕様の変更があった場合、実装のみを変えるとテストでエラーになるため、ド キュメントの更新を強制され、実装とドキュメントの乖離を防ぎます。
8. ご静聴ありがとうございました