Open API + Railsでテストをいい感じにした話

Open API + Railsでテストをいい感じにした話平成.rb 2019/7/18 @__syumai

自己紹介 syumai 平成4年生まれ前職: 株式会社maricuruにてRailsを使ったAPI開発、React / Vue を使ったフロントエンド開発等を行っていました現職: 決済系の会社でGoのマイクロサービスを開発しています

はじめに

めっちゃWIPです！

本日のテーマ Open API

Open API or Swagger使ってますか？

Open APIとは? YAML / JSONでAPI Specを書ける Swagger 3.0がそのままOpen API 3.0と呼ばれています
書いたAPI Specから色々生成出来る

生成できるものその1 HTMLのいい感じのドキュメントフォームの送信とかも試せる！ (Postman的なやつ)

生成できるものその2 サーバー / クライアントの生成サーバーのinterfaceや、クライアントライブラリ (言語めっちゃある) を自動生成出来る多言語のクライアントを生成したい時にめちゃくちゃ便利

クライアント生成できる言語 https://github.com/OpenAPITools/openapi-generator Ruby / Node.js / TypeScript / Javaなど色々あります

Open APIのSpecのサンプル

Open APIのドキュメントのサンプル

Open APIを使っている人からよく聞く課題 APIの実装とドキュメントがズレてくるドキュメントがズレてるから、誰もメンテしなくなる実装とドキュメントがズレると、自動生成したクライアントが使えなくなる

ドキュメントがズレる理由 APIの実装を行う作業と、ドキュメントを書く作業が分離してしまっているためこれを統合できたら解決するはず！

どう解決したか？テストでRailsのAPIを起動するテストに Open APIで生成したClient を使う

このやり方の良い点同じSpecから生成したClientをJSで使うとして、 Testさえ通っていれば、Client側から使えるのが保証される！

具体的なやり方 Makefileでテスト起動周りをいい感じに書いていく Railsサーバーの起動 Rspecの実行

デモします！！

ポイントテスト用のRailsサーバーと、Rspecで使うDBを共通にする

つらみエラーが出た箇所のログ追うのがつらい

ご清聴ありがとうございました！！

syumai