APIドキュメンテーションとmockサーバ #meguroes #gotandajs

by mizuki_r

Slide 1

Slide 1 text

APIドキュメンテーションと mockサーバ 2017/04/28 Meguro.es x Gotanda.js @mizuki_r

Slide 2

Slide 2 text

@mizuki_r • シニアフロントエンドエンジニア • エンジニア 2 #javascript #gotandajs #meguroes #perl #kichijojipm 五反田のM社で位置ゲー開発に携わる。  エンジニアとして新卒入社して7年目に突入。3年目くらいからフロントエンドエンジニアを兼任。 about me こんな人です

Slide 3

Slide 3 text

theme

Slide 4

Slide 4 text

APIドキュメンテーションと mockサーバ

Slide 5

Slide 5 text

まあつまりは、   harikoの話です

Slide 6

Slide 6 text

hariko

Slide 7

Slide 7 text

what is hariko • JSON API Mock Server. • API-Blueprint based.

Slide 8

Slide 8 text

why talk about hariko • ࠷ۙ࢖ͬͯΔ • ͪΐͬͱલʹΞοϓσʔτͨ͠ • ͦ͏ݴ͑͹ͪΌΜͱ঺հͯ͠ͳ͍ͳˡ

Slide 9

Slide 9 text

context

Slide 10

Slide 10 text

開発体制 ཁ݅ UI API ϞοΫ API αʔ ό ʔ ·ͣ͸UI ৘ใΛ੔ཧ͠ αʔόΛ ࡞Γ UIʹ൓ө͢Δ

Slide 11

Slide 11 text

解決したい問題 • stubcell / json mockͳͲ͸JSONΛஔ͚ͩ͘ • આ໌ɾυΩϡϝϯςʔγϣϯ͕ෆ଍ • υΩϡϝϯτͱͯ͠੔ܗ͞Εͳ͍͠ɺͦ΋ͦ΋ಡ Έʹ͍͘ →͜Ε͸API-Blueprint͕ղܾͯ͘͠ΕΔ

Slide 12

Slide 12 text

harikoで解決したい • MemberResourceͷදݱΛ࠷খͰॻ͖͍ͨ • ϖʔδϟʔͷόϦΤʔγϣϯΛදݱ͍ͨ͠ • खಈͰΞϓϦέʔγϣϯͷڍಈΛ࠶ݱ͍ͨ͠ →ͨͩͷJSONΑΓ΋ͪΐͬͱݡ͍ͨ͘͠

Slide 13

Slide 13 text

hariko’s power

Slide 14

Slide 14 text

複数のレスポンスのパターン /api/users/:idͱ͍͏API͕͋Δͱͯ͠ɺ id͕1, 2, 3, ͦͷଞͰҧ͏ϨεϙϯεΛฦ͍ͨ͠

Slide 15

Slide 15 text

クエリパラメータによってレスポンスを変えたい /api/items?page=1 /api/items?page=2 Ͱ10݅ͱ5݅ͰϨεϙϯεΛฦ͍ͨ͠

Slide 16

Slide 16 text

オンラインでデータを書き換えたい 1. POST /api/messagesʹϦΫΤετΛૹΔ 2. mockΛ௥ه͢Δ 3. GET /api/messagesΛୟ͘ͱ௥هͨ͠σʔλ Λड͚औΕΔ

Slide 17

Slide 17 text

demo

Slide 18

Slide 18 text

まとめ

Slide 19

Slide 19 text

まとめ • harikoͷ঺հͰͨ͠ • େن໛ͳAPIΛ؅ཧ͢ΔͨΊͷॊೈੑΛ࣋ͬͨMockαʔόͰ ͢ • ҎԼͷΑ͏ͳํʹ͓͢͢ΊͰ͢ • JSONஔ͚ͩ͘͡Ό΋͏ͭΒ͍ • ॊೈʹΑ͠ͳʹͯ͠΄͍͠

Slide 20

Slide 20 text

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