Upgrade to Pro — share decks privately, control downloads, hide ads and more …

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

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

Meguro.es x Gotanda.js での発表資料です

mizuki_r

April 28, 2017
Tweet

More Decks by mizuki_r

Other Decks in Technology

Transcript

  1. APIドキュメンテーション

    mockサーバ
    2017/04/28 Meguro.es x Gotanda.js
    @mizuki_r

    View full-size slide

  2. @mizuki_r
    • シニアフロントエンドエンジニア
    • エンジニア
    2
    #javascript #gotandajs
    #meguroes #perl #kichijojipm
    五反田のM社で位置ゲー開発に携わる。

    エンジニアとして新卒入社して7年目に突
    入。3年目くらいからフロントエンドエン
    ジニアを兼任。
    about me
    こんな人です

    View full-size slide

  3. APIドキュメンテーション

    mockサーバ

    View full-size slide

  4. まあつまりは、

    harikoの話です

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

  10. hariko’s power

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide