よりよいAPIを作るために

Slide 1

Slide 1 text

ΑΓΑ͍"1*Λ࡞ΔͨΊʹ /BPZPTIJ"JLBXB !BXBLJB .JDSPTFSWJDFT.FFUVQ

Slide 2

Slide 2 text

✤ Wantedlyʹ͸4೥2ϲ݄ɻ4ਓͷ࣌ʹೖͬͨɻ ✴ Web։ൃ => ΠϯϑϥϦʔμʔ ✴ ػցֶश΋࠷ۙ΍ͬͯ·͢ ✤ લ৬ɿGoogleͰݕࡧͷνʔϜ ✤ Qiita݁ߏॻ͍ͯ·͢ ࣗݾ঺հ

Slide 3

Slide 3 text

ࠓ೔ͷ಺༰: ઌ೔Πϯλʔϯ͕΍ͬͨ ࣾ಺ษڧձͰόζͬͯ͠·͍·ͨ͠…

Slide 4

Slide 4 text

ࠓ೔ͷ಺༰: ઌ೔Πϯλʔϯ͕΍ͬͨ ࣾ಺ษڧձͰόζͬͯ͠·͍·ͨ͠…

Slide 5

Slide 5 text

Wantedlyʹ͍ͭͯ 1 2 3 ྫ: ؾͷ߹͏஥ؒͱ΍Γ͍ͨγΰτΛ୳ͤΔαʔϏε ϛογϣϯ:ʮγΰτͰίίϩΦυϧਓΛ૿΍͢ʯ

Slide 6

Slide 6 text

Feed - γΰτͰ΍͍ͬͯΔ͜ͱΛൃ৴

Slide 7

Slide 7 text

Tools - πʔϧͷޱίϛ / Ϛʔέοτ

Slide 8

Slide 8 text

Sync - άϧʔϓϝοηʔδ ࣾ֎ͷਓͱͷίϛϡχέʔγϣϯ΋ޮ཰తʹ

Slide 9

Slide 9 text

1. ͲΜͲΜ৽͍͠αʔϏεΛ  ఏڙ͍͖͍ͯͨ͠ 2. ޮ཰։ൃ͢ΔͨΊʹɺࣗ༝ʹ  ݴޠ΍ArchitectureΛબͼ͍ͨ 3. গਓ਺νʔϜͰߦ͍͖͍ͬͯͨ • ΤϯδχΞ: 25ਓ • Πϯϑϥ: 3ਓ ΠϯϑϥʹٻΊΒΕ͍ͯΔ͜ͱ Go ʮطଘʯΑΓʮ৽نʯͷํ͕େมʹ python

Slide 10

Slide 10 text

✤ Docker͸1೥൒લ͔Βಋೖ ✴ ཧ༝: Heroku͔ΒͷҠߦ ✴ σϓϩΠ࣌ؒΛ୹͔ͨͬͨ͘͠ ✤ OS΋ܦݧ͔ΒશͯCoreOS ✤ ͱ͸͍͑ɺMonolithic Railsͩͬͨ ✴ ͦΜͳαʔϏεͳ͔ͬͨ͠… ✴ ࠓ͸αʔϏε΋૿͑ɺ࣮ࡍʹϚΠΫϩαʔϏε Խ͖͍ͯͯ͠Δ Wantedlyͷݱঢ়

Slide 11

Slide 11 text

Ͳ͏ͳͬͨΒ ϚΠΫϩαʔϏε͔

Slide 12

Slide 12 text

1. ͜ͷ࣌఺ΑΓɺશͯͷνʔϜ͸αʔϏεΠϯλʔϑΣʔεΛ௨ͯ͡શͯ ͷσʔλͱػೳΛެ։͢Δ͜ͱ 2. ֤νʔϜ͸֤ʑͦͷΠϯλʔϑΣʔεΛ௨ͯ͡௨৴͠ͳ͚Ε͹ͳΒͳ͍ 3. ͦͷଞͷશͯͷϓϩηεؒ௨৴͸ڐՄ͞Εͳ͍ɻμΠϨΫτϦϯΫɺ ଞͷνʔϜͷσʔλιʔε͔Β௚઀σʔλΛಡΉ͜ͱɺϝϞϦڞ༗Ϟ σϧɺόοΫυΞɺશͯΛې͡ΔɻωοτϫʔΫӽ͠ͷαʔϏεΠϯλʔ ϑΣʔεΛܦ༝ͨ͠௨৴͚͕ͩڐՄ͞ΕΔ 4. ࢖༻͢Δٕज़͸໰Θͳ͍ɻ HTTP ɺ Corba ɺ Pubsub ɺ ΧελϜϓ ϩτίϧɺԿͰ΋ྑ͍ɻ Bezos ͸ؾʹ͠ͳ͍ 5. શͯͷαʔϏεΠϯλʔϑΣʔε͸ɺྫ֎ͳ͘ɺ֎෦ʹެ։ՄೳͳΑ͏ ʹθϩ͔Βઃܭ͞Εͳ͚Ε͹ͳΒͳ͍ɻ͢ͳΘͪɺνʔϜ͸શੈքͷ σϕϩούʹ޲͚ͯΠϯλʔϑΣʔεΛެ։͢Δ͜ͱ͕Ͱ͖ΔΑ͏ɺઃ ܭ͠ɺܭը͠ͳ͚Ε͹ͳΒͳ͍ɻྫ֎͸ແ͍ 6. ͦ͏͠ͳ͍ऀ͸ղޏ͞ΕΔ 2002೥ʹAmazonͷࣾ௕͕ग़ͨ࢘͠ྩ http://anond.hatelabo.jp/20111018190933

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Microservices׬੒ܗ API Gateway Swift Android Java React Angular API Request API Request Kong Kubernetes Go Rails Python api.wantedly.com /bot /v2 /v1 Mobile PC

Slide 15

Slide 15 text

Microservicesͷલ (Monolithic) Swift Android Java Rails API Request Render HTML Rails www.wantedly.com Mobile PC

Slide 16

Slide 16 text

Microservices׬੒ܗ API Gateway Swift Android Java React Angular API Request API Request Kong Kubernetes Go Rails Python api.wantedly.com /bot /v2 /v1 Mobile PC

Slide 17

Slide 17 text

BFF(Backends for Frontends) • ϦΫΤετʹBFFΛհ͢͜ͱͰRESTAPIΛFrontendଆʹͱͬͯద͠ ͨܗʹͯ͠ฦ͢ • RESTαʔόʔଆ͸DBͷΫΤϦ݁ՌΛͦͷ··JSONͱͯ͠ฦ͢Α͏ ͳγϯϓϧͳߏ੒ʹ͢Δ Client Server(API) Mobile PC #'' 4FSWFS #'' 4FSWFS Kong "1* (BUXBZ 4JNQMF 3&45 4FSWFS "1* HBU FX BZ 4JNQMF 3&45 4FSWFS

Slide 18

Slide 18 text

៉ྷͳ"1*Λॻ͘ʹ͸

Slide 19

Slide 19 text

Ұ؏ͨ͠ύε໊Λ࢖͏ Ϧιʔε • ඪ४Ͱෳ਺ܗʹ͢Δ • γεςϜશମͰγϯάϧτϯͳ৔߹͸ɺ୯਺ܗ ΞΫγϣϯ • جຊHTTPϝιουͳͷͰಈࢺ͸ؚΊͳ͍ • ඞཁͳ৔߹͸ɺΞΫγϣϯ໊Λactionsͷޙʹଓ͚ͯهड़ Φϓγϣϯ • ໊ࢺͰ͸ͳ͍ͷͰɺύεͰ͸ͳ͘ΫΤϦύϥϝʔλͰઃఆ͢Δ /resources/:id/actions/:action

Slide 20

Slide 20 text

ύεͷωετΛ࠷খݶʹ͢Δ • ϧʔτύεʹϦιʔεΛ഑ஔ͢ΔΑ͏ʹύεͷωε τͷਂ͞͸੍ݶ͢Δ • ωετ͸͋Δಛఆͷൣғͷू߹Λࣔͨ͢Ίʹ࢖͏ /orgs/{org_id}/apps/{app_id}/dynos/{dyno_id} /orgs/{org_id} /orgs/{org_id}/apps /apps/{app_id} /apps/{app_id}/dynos /dynos/{dyno_id} app͕orgʹ෇ਵͯ͠ͷΈ ଘࡏ͢ΔͳΒ͜ͷύε΋Α͠ WantedlyͰ͸ϦϨʔγϣϯઌ͸ ?preloads=app ͱ͍͏ΫΤϦͰಡΈࠐΉܗʹ

Slide 21

Slide 21 text

ϑΟʔϧυΛߜΔΫΤϦΛ͚ͭΔ APIʹେ੾ͳ͜ͱ • ͍͔ʹޮ཰తʹૣ͘σʔλऔಘͰ͖Δ͔ • ίʔϧ਺ΛۃྗݮΒ͢ • 1ίʔϧ͋ͨΓͷσʔλ௨৴ྔΛۃྗݮΒ͢ ? fieldsΫΤϦ • Ϩεϙϯεʹ͓͍ͯࢦఆͨ͠field໊ͷΈΛநग़ͨ͠ܗͰฦ͢Α͏ʹϨεϙϯ εΛϑΟϧλϦϯά͢Δ • ΍Γ͗͢Ͱ͕͢ɺFacebook͸fieldsΛࢦఆ͠ͳ͍ͱϨεϙϯε͸ۭʹͳΔ [ { "id": 10, "name": "shirt", "age": 30, "email": "hoge@hoge.com", "tel": "090XXXXXXXX", }, { "id": 11, …… [ { "id": 10, "name": "shirt", }, { "id": 11, "name": "hoge", }, …… ]

Slide 22

Slide 22 text

ϦϨʔγϣϯઌΛPreload͢Δ ? preloadsΫΤϦ • ϦϨʔγϣϯؒͷN+1໰୊Λආ͚ΔͨΊʹࢦఆͨ͠Ϟσϧ ͷϦϨʔγϣϯઌΛࣄલʹpreload͢Δ { "id":1, "name":"NAME", "account_id":1 } { "id":1, "name":"NAME", "account": { "id":1, "account_name":"ACCOUNT", } } GET /user GET /user ?preloads=account

Slide 23

Slide 23 text

Version͸HeaderͰ؅ཧ͢Δ 63-ͩͱ FYBNQMFDPNWVTFST w Ϧιʔεʹόʔδϣϯؚ͕·Εͯඒ͘͠ͳ͍ w 3PVUJOHͷॲཧ΍63-͔ΒόʔδϣϯΛऔಘ͢Δͷ΋Ұखؒ )FBEFSͩͱ "DDFQUTBQQMJDBUJPOKTPOWFSTJPO w 3&45ͷݪଇʹै͍ͬͯΔΑΓඒ͍͠63*ߏ੒ w $POUSPMMFS಺Ͱͷ෼ذ΋ΫϥΠΞϯτଆͷऔಘ΋ॻ͖΍͍͢ Server΋Client΋ѻ͍ͮΒ͍ Server΋Client΋ѻ͍΍͍͢

Slide 24

Slide 24 text

Version෼ذ͸ݶہ෼ذ • Controller෼ׂ͸อक͕ඇৗʹࠔ೉ • ґଘύοέʔδͷΞοϓσʔτͰੲͷ࣮૷Λ͍͡Δ ࿑ྗ͸ඞͣੜ͡Δ • Controller಺ͷݶఆతͳ෼ذͰ؅ཧ͢Δ • ܗࣜ͸SemanticVersioningΛ࢖͏ if version.Range(ver, "<", "1.0.0") { // conditional branch by version. // this version < 1.0.0 !! c.JSON(400, gin.H{"error": "this version (< 1.0.0) is not supported!"}) return }

Slide 25

Slide 25 text

meta-data͕Bodyʹ͋Δͱѻ͍ͮΒ͍ • ड͚औΓ͔ͨͬͨσʔλ͕௚ײతʹΘ͔Βͳ͍ • ΫϥΠΞϯτଆ͸ύʔε͢ΔҰख͕ؒੜ͡Δ • αʔόʔଆʹͱͬͯ΋Ճ޻ͮ͠Β͍ • ྫ͑͹ɺෳ਺ͷAPIΛ̍ͭʹՃ޻ͯ͠ฦ͢ࡍʹҰͭҰͭύʔεͯ͠ meta-dataΛऔΓআ͔ͳ͍ͱ͍͚ͳ͍ { "data": [ ... Endpoint data is here ], "paging": { "previous": "/albums?limit=25&after=MTAxNTExOTQ1MjAwNzI5NDE=", "next": "/albums?limit=25&after=MTAxNTExOTQ1MjAwNzI5NDE=" } } BodyʹೖΕΔͱ…(Facebook) Server΋Client΋ѻ͍ͮΒ͍

Slide 26

Slide 26 text

Paging΋HeaderͰఏڙ͢Δ • BodyͷϨεϙϯε͕௚ײతʹ • Ճ޻͠΍͍͢Ϩεϙϯε HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Link: ; rel="next", ; rel="last", ; rel="first", ; rel="prev" Date: Mon, 01 Aug 2016 03:33:50 GMT Content-Length: 5 [ { "id": 10, "name": "shirt" }, { "id": 11, "name": "shirt" } ] HeaderʹLinkͱͯ͠ೖΕΔ(Github) Server΋Client΋ѻ͍΍͍͢

Slide 27

Slide 27 text

ద੾ͳPagingΛ೺Ѳ͓ͯ͘͠ Listܕ • ࣌ܥྻʹ͍ͭͯ͸ͩ͜ΘΒͣɺฦ͞ΕͨಛఆͷΦϒδΣΫτͷϦετ • sample.com/users?page=2&limit=5 Feedܕ • σʔλͷϦετͰಛఆͷ࣌ؒ, idΛ࢖ͬͯɺιʔτͨ͠ϨεϙϯεΛฦ ͢ • sample.com/users?limit=5&last_id=100&order=desc Cursorܕ • Ϩεϙϯε಺ͷಛఆͷΞΠςϜʹϚʔΫΛ෇͚ͨτʔΫϯΛج఺ʹͯ͠ લޙΛಡΈࠐΉ • SNSͳͲͷେྔͷ௥Ճ࡟আ͕ൃੜ͢Δ΋ͷΛਖ਼֬ʹऔಘ͢Δ