Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Open API + Railsでテストをいい感じにした話
Search
syumai
July 18, 2019
1
150
Open API + Railsでテストをいい感じにした話
WIPです
syumai
July 18, 2019
Tweet
Share
More Decks by syumai
See All by syumai
StarlingMonkeyを触ってみた話 - 2024冬
syumai
3
360
初めてDefinitelyTypedにPRを出した話
syumai
1
570
利用者視点で考える、イテレータとの上手な付き合い方
syumai
5
680
ECMAScript仕様を読むのに必要な知識 - ダイジェスト版
syumai
7
3.4k
コード生成を活用したgqlgen+dataloaderの実装パターン解説
syumai
7
970
Goのmultiple errorsについて (2024年4月版)
syumai
5
9k
ECMAScript仕様の読み方ガイド 〜比較演算子編〜
syumai
7
950
Go言語で始めるCloudflare Workers
syumai
9
2.8k
xoのコード生成でgqlgenのDataLoader実装を楽にした話
syumai
2
440
Featured
See All Featured
Documentation Writing (for coders)
carmenintech
67
4.6k
BBQ
matthewcrist
87
9.5k
Scaling GitHub
holman
459
140k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
44
7k
Statistics for Hackers
jakevdp
797
220k
The Illustrated Children's Guide to Kubernetes
chrisshort
48
49k
Building Your Own Lightsaber
phodgson
104
6.2k
It's Worth the Effort
3n
184
28k
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
29
1k
Faster Mobile Websites
deanohume
306
31k
Large-scale JavaScript Application Architecture
addyosmani
511
110k
The MySQL Ecosystem @ GitHub 2015
samlambert
250
12k
Transcript
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を共通にする
つらみ エラーが出た箇所のログ追うのがつらい
ご清聴ありがとうございました!!