Meguro.es x Gotanda.js での発表資料です
APIドキュメンテーションとmockサーバ2017/04/28 Meguro.es x Gotanda.js@mizuki_r
View Slide
@mizuki_r• シニアフロントエンドエンジニア• エンジニア2#javascript #gotandajs#meguroes #perl #kichijojipm五反田のM社で位置ゲー開発に携わる。 エンジニアとして新卒入社して7年目に突入。3年目くらいからフロントエンドエンジニアを兼任。about meこんな人です
theme
APIドキュメンテーションとmockサーバ
まあつまりは、 harikoの話です
hariko
what is hariko• JSON API Mock Server.• API-Blueprint based.
why talk about hariko• ࠷ۙͬͯΔ• ͪΐͬͱલʹΞοϓσʔτͨ͠• ͦ͏ݴ͑ͪΌΜͱհͯ͠ͳ͍ͳˡ
context
開発体制ཁ݅ UIAPIϞοΫAPIαʔόʔ·ͣUI ใΛཧ͠αʔόΛ࡞ΓUIʹө͢Δ
解決したい問題• stubcell / json mockͳͲJSONΛஔ͚ͩ͘• આ໌ɾυΩϡϝϯςʔγϣϯ͕ෆ• υΩϡϝϯτͱͯ͠ܗ͞Εͳ͍͠ɺͦͦಡΈʹ͍͘→͜ΕAPI-Blueprint͕ղܾͯ͘͠ΕΔ
harikoで解決したい• MemberResourceͷදݱΛ࠷খͰॻ͖͍ͨ• ϖʔδϟʔͷόϦΤʔγϣϯΛදݱ͍ͨ͠• खಈͰΞϓϦέʔγϣϯͷڍಈΛ࠶ݱ͍ͨ͠→ͨͩͷJSONΑΓͪΐͬͱݡ͍ͨ͘͠
hariko’s power
複数のレスポンスのパターン/api/users/:idͱ͍͏API͕͋Δͱͯ͠ɺid͕1, 2, 3, ͦͷଞͰҧ͏ϨεϙϯεΛฦ͍ͨ͠
クエリパラメータによってレスポンスを変えたい/api/items?page=1/api/items?page=2Ͱ10݅ͱ5݅ͰϨεϙϯεΛฦ͍ͨ͠
オンラインでデータを書き換えたい1. POST /api/messagesʹϦΫΤετΛૹΔ2. mockΛه͢Δ3. GET /api/messagesΛୟ͘ͱهͨ͠σʔλΛड͚औΕΔ
demo
まとめ
まとめ• harikoͷհͰͨ͠• େنͳAPIΛཧ͢ΔͨΊͷॊೈੑΛ࣋ͬͨMockαʔόͰ͢• ҎԼͷΑ͏ͳํʹ͓͢͢ΊͰ͢• JSONஔ͚ͩ͘͡Ό͏ͭΒ͍• ॊೈʹΑ͠ͳʹͯ͠΄͍͠
ご清聴ありがとうございました