how-to-find-restful-api

by MOROHASHI Kyosuke

Slide 1

Slide 1 text

RESTful APIͷ Έ͚͔ͭͨ 2015-08-19 @moro

Slide 2

Slide 2 text

ॾڮګհ(@moro) Kyosuke MOROHASHI

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

άϥϯυϧʔϧ

Slide 5

Slide 5 text

3&45GVMͱ͸%# ͷςʔϒϧΛͦͷ· ·IUUQͰެ։͢Δ͜ ͱΛࢦ͢ͷͰ͸ͳ͍

Slide 6

Slide 6 text

‣ύεϫʔυ͸ݟͤͳ͍ɺͱ ͔ͦ͏͍͏࿩Ͱ΋ͳ͍ ‣Ϟϊͷ৔߹ɺಉ͡Α͏ʹͳ Δ͜ͱ΋ଟ͍

Slide 7

Slide 7 text

‣ Web ΞϓϦέʔγϣϯ͕ఏڙ͢ΔػೳΛ ‣ Ϣʔβʹ໾ཱཻͭ౓(Ϧιʔε)Ͱ  ந৅Խ͠ ‣ ͦͷϦιʔε΁ͷγϯϓϧͳૢ࡞(CRUD) Λߦ͏͜ͱͰ ‣ Ϣʔβͷ༻ΛຬͨͤΔΑ͏ʹ͢ΔΞʔΩ ςΫνϟύλʔϯ

Slide 8

Slide 8 text

‣Web ΞϓϦέʔγϣϯ͕  ఏڙ͢ΔػೳΛ ‣Ϣʔβʹ໾ཱཻͭ౓  (Ϧιʔε)Ͱந৅Խ

Slide 9

Slide 9 text

RESTful APIͷ Έ͚͔ͭͨ 2015-08-19 @moro

Slide 10

Slide 10 text

%#ͷ   ϦιʔεΤϯςΟ ςΟى఺

Slide 11

Slide 11 text

‣ϞϊͷCRUD ‣ POST /articles ‣Ұ൪ Θ͔Γ΍͍͢ ‣Α͘αϯϓϧʹग़ͯ͘Δ

Slide 12

Slide 12 text

%#ͷ   ΠϕϯτΤϯ ςΟςΟى఺

Slide 13

Slide 13 text

‣ؔ܎ੑͷCRUD ‣ POST /groups/42/memberships ‣2൪Ί?ʹΘ͔Γ΍͍͢  ݸਓతʹ޷͖

Slide 14

Slide 14 text

‣ʙ͢Δ/ͨ͜͠ͱ ‣DBςʔϒϧ͕͋ΔͷͰ  Θ͔Γ΍͍͢ ‣has_many :through Ͱ  ࢦఆ͢Δ΍ͭ

Slide 15

Slide 15 text

αϒϦιʔεͷ ૢ࡞

Slide 16

Slide 16 text

‣add_fooͨ͘͠ͳͬͨΒ  ߟ͑Δ ‣POSTͷ͜ͱ͕ଟ͍ ‣ϦιʔεͷURIܾ·ΔͳΒ PUT ΋͋Γ

Slide 17

Slide 17 text

# よくやっちゃう。こうしたくなったら POST /articles/42/add_comment   # サブリソースへ落とせる POST /articles/42/comments # config/routes  resources :articles do resources :comments end

Slide 18

Slide 18 text

‣verb+object ͳΞΫγϣϯ ͸͍͍ͩͨαϒϦιʔε΁ ‣΋ͪΖΜࢀরͳΒGET

Slide 19

Slide 19 text

αϒίϨΫγϣ ϯͷૢ࡞

Slide 20

Slide 20 text

‣ಛఆͷςʔϚͰ·ͱΊͨϦ ιʔεͷू߹ ‣indexͰ৚݅෼ذΛؤுΓ ա͗ͨΒ

Slide 21

Slide 21 text

# あと4つくらいパラメータが増える GET /articles?filter=favorited&limit=3 # これは典型的なまとまりに名前をつけるとよい GET /articles/hot

Slide 22

Slide 22 text

‣ΞΫγϣϯ͕෼͔ΕΔͷͰ ͖ͬ͢Γ͢Δ

Slide 23

Slide 23 text

͏Μͪ͘: routing ͸ηϨΫλϒϧσΟ εύονͳΘ͚ͰɺΑ͏͢ΔʹͦΕ ࣗମ෼ذͷҰछɻ ͦΕΛҰͭॲʹ·ͱΊ্ͨͰ΋͏Ұ ճࣗ෼Ͱ෼ذΛॻ͖௚͢ɺΈ͍ͨͳ ͜ͱΛ͢Δͷ͸ෆໟɻ

Slide 24

Slide 24 text

ϝϯόϦιʔε ͷૢ࡞

Slide 25

Slide 25 text

‣ ಛఆͷ(ൺֱతେࣄͳ)ଐੑͷૢ࡞ɻ ‣ set_foo Έ͍ͨͳϧʔςΟϯάΛॻ ͖ͨ͘ͳͬͨΒίϨɻ ‣ POST ΍ PUT ͷ͜ͱ͕ଟ͍ɻ

Slide 26

Slide 26 text

# 記事を下書きから公開にする例 # set_foo ではなく POST /articles/42/set_public # public -> publication と名詞にした上で # それを「作成」する PUT /articles/42/publication # 非公開にするには「公開していること」を消す POST /articles/42/set_private DELETE /articles/42/publication

Slide 27

Slide 27 text

τϥϯβΫγϣϯ  Ϧιʔε

Slide 28

Slide 28 text

‣ ʮେ͖Ίͷॲཧ͢Δ͜ͱʯΛ ද͢Ϧιʔε ‣ ಛʹɺෳ਺ͷσʔλΛ·ͱΊ ͯѻ͏Α͏ͳ৔߹ʹ࢖͏

Slide 29

Slide 29 text

‣ ࡞Δ͚ͩͰͳ͘ɺ࣮ߦ΍݁Ռ ֬ೝ·ͰؚΉɺॲཧશମΛϦ ιʔεͱͯ͠ந৅Խ͢Δ ‣ ࣮૷తʹ͸ɺॲཧͷ࣮ମ͸ඇ ಉظJob ʹྲྀ͢͜ͱ΋͋Δ

Slide 30

Slide 30 text

=begin 実際の例: とある条件で、たくさんのデータをエクスポートする必要あり。まずはエクスポート条件を指定する画面 (ユーザナビゲーション用のリソースが必要) =end # ここでは条件指定フォームを表示 GET /foo_exports/new # 指定した条件でエクスポート処理リソース作成。 # 処理の本体はActiveJobとかに POST /foo_exports

Slide 31

Slide 31 text

# ジョブを作ったら詳細にリダイレクト # ジョブの進捗を出せる範囲で出しておく GET /foo_exports/42 # しばらく待ってリロードすると(※)終わる。 # 結果やログへのナビゲーションをつけておく GET /foo_exports/42/data.csv GET /foo_exports/42/log.txt // ※ もちろんもっといまふうなWebSocketとかでもOK

Slide 32

Slide 32 text

αϒϦιʔεͷ ΠϯϥΠϯԽ

Slide 33

Slide 33 text

‣ ؔ࿈͍ͯ͠ΔϦιʔε͸JSON ͳͲͰωετ͢Δɻ ‣ ωετ͠ͳ͍৔߹ͷࢀর͸ URLͰɻ ‣ id ͚ͩͰ૊Έཱͯ͸ආ͚Δɻ

Slide 34

Slide 34 text

{article: { id: 42, tiltle: 'RESTful API ͷΈ͚͔ͭͨ', url: ‘http://speaekrdeck.com/moro/...', comments: [ {id: 1, body: '͍͢͝'}, {id: 2, body: 'ײಈͨ͠'}, ] }}

Slide 35

Slide 35 text

"3FT͸ਓྨʹ ૣ͗͢Δ࿩

Slide 36

Slide 36 text

͸ɺࠓ೔͸͠·ͤΜ

Slide 37

Slide 37 text

σβΠϯͷ ώϯτ

Slide 38

Slide 38 text

‣ Railsͷ`resources`͕࡞Δ͢΂ͯͷΞΫ γϣϯΛ࣋ͭඞཁ͸ͳ͍ɻ ‣ ͋ͷαϒηοτͱͯ͠ɺϦιʔεΛૢ࡞ ͭͭ͠ɺϦϯΫ΍ϑΥʔϜΛ࢖ͬͯΞ ϓϦέʔγϣϯΛ࡞Δ͜ͱ͕େࣄɻ

Slide 39

Slide 39 text

Α͋͘Δ  φϏήʔγϣϯྫ

Slide 40

Slide 40 text

‣ Ұཡը໘ͷԼ෦ʹ௥ՃϑΥʔϜ͕͋Δ  (`new` ͕ͳ͍) ‣ ফͤͳ͍ͷͰ delete ͕ͳ͍ ‣ मਖ਼Ͱ͖ͳ͍ͷͰ edit / update ͕ͳ͍ɻ

Slide 41

Slide 41 text

‣ ৄࡉը໘ͷதͰɺ͸͡Ί͔ΒςΩετ ϑΟʔϧυʹ஋͕ॻ͍ͯ͋Δ ‣ or JSͰϑΥʔϜΛ࡞ͬͨΓ͢ΔͷͰ͢ ͙ʹߋ৽Ͱ͖Δ(edit ͕ͳ͍) ‣ ਌Ϧιʔεͷৄࡉը໘ʹࢠϦιʔε͕ද ࣔ͞ΕΔɻ(index ΋ show ΋ͳ͍)

Slide 42

Slide 42 text

ಠࣗݚڀ

Slide 43

Slide 43 text

ෳ߹Ϧιʔε ଟछϙʔλϧ

Slide 44

Slide 44 text

‣Q: RESTfulAPIͰʮϙʔλ ϧϖʔδʯΛͲ͏࡞Δ͔ ‣ ͍ΖΜͳ΋ͷΛ౎౓औΓʹߦ͘ͱϦΫ Τετ਺૿͑͗ͯͭ͢Β͍

Slide 45

Slide 45 text

‣ ৽ணΤϯτϦ10݅ ‣ ਓؾΤϯτϦ10݅ ‣ ͓஌Βͤ 3݅ ‣ χϡʔε 5݅ …