Google API Design Guideを読んだまとめ

Google API Design GuideからAPI設計を学ぶ

Transcript

1. Google API Design Guide Λ ಡΜͩ·ͱΊ @peka2
2. APIྺ • Yahoo! ϘοΫε APIઃܭɾ։ൃ • ϠϑΦΫAPIΨΠυϥΠϯ࡞੒ • ϠϑΦΫΞϓϦAPIઃܭɾ։ൃ
3. Ϟνϕʔγϣϯ • ࠷ۙެ։͞ΕͨAPIσβΠϯΨΠυ • TechGiant͸APIઃܭ͔Βֶͼ͍ͨ
4. Google API Design Guideͱ͸ • https://cloud.google.com/apis/design/ • 2017 2/20 ʹެ։͞Εͨ • 2014೥͔ΒGoogle಺෦Ͱ࣮ࡍʹ࢖ΘΕ͍ͯΔAPIσβΠϯΨ Πυ • REST, gRPC ͲͪΒʹͰ΋࢖͑ΔΑ͏ʹ࡞ΒΕͯΔ • ܾఆ൛Ͱ͸ͳ͘ɺ೔ʑ௥ه͞Ε͍ͯ͘
5. Google API Design Guide • جຊ͸RESTful
6. ΧελϜϝιου • httpϝιουʹϚοϐϯάͰ͖ͳ͍ૢ࡞ʹରͯ͠ɺ࡞ͬͯྑ ͍ • :ಈࢺ Λ࠷ޙʹ͚ͭͯࣔ͢ • ϝιου͸ॊೈͰ͋ΔPOSTΛਪ঑ • PATCHͰ࢖͏΂͖Ͱ͸ͳ͍ https://service.name/v1/some/resource/name:customVerb
7. ΧελϜϝιου࢖༻ྫ • VM࠶ىಈ • ঢ়ଶͷભҠΛߦ͏API΍ɺ࠶ىಈϦιʔεΛ࡞ΔAPIΑΓ΋ɺΧελϜϝ ιουͷํ͕௚ײత • ϝʔϧૹ৴ • υϥϑτˠૹ৴τϨΠ΁Ҡಈɺͱ͍͏σβΠϯΑΓ΋ɺΧελϜϝιο υͷํ͕௚ײత • RESTfulʹͩ͜ΘΔΑΓ΋ɺϢʔβ͕௚ײతʹΘ͔Δ͜ͱ͕ॏཁ
8. ͦ΋ͦ΋RESTfulͬͯ • ։ൃऀؒͷηϚϯςΟοΫΪϟοϓΛຒΊΔ͜ͱͰɺ୭ʹ Ͱ΋௚ײతͳAPIΛઃܭͰ͖Δͷ͕ར఺ͷҰͭ • ແཧ΍ΓRESTfulΛద༻͢Δ͜ͱͰখ೉͍͠APIʹͳͬͯ ͠·͏ͳΒɺΧελϜϝιουͷ΄͏͕௚ײత
9. Τϥʔදݱ • Τϥʔίʔυ͸গͳ͚Ε͹গͳ͍΄Ͳɺ ΫϥΠΞϯτͷϩδοΫ͕ෳࡶʹͳΒ ͳͯ͘ࡁΉ • https://github.com/googleapis/ googleapis/blob/master/google/ rpc/code.proto • 15छྨ • statusʢΤϥʔίʔυʣ͸਺ྻͰ͸ͳ ͘ɺਓؒͰ΋ಡΊΔӳ୯ޠΛ࢖ͬͯΔ
10. ϖʔδωʔγϣϯ • ϦετԽͰ͖ΔίϨΫγϣϯ͸ͲΜͳখ͞ͳ΋ͷͰ΋ϖʔδωʔ γϣϯΛ࣮૷͓ͯ͘͠΂͖ • طଘͷAPIʹϖʔδωʔγϣϯΛޙ͔Β࣮૷͢Δͱɺݩʑશ݅ ฦ͍ͯͨ͠΋ͷ͕̍ϖʔδ໨ʢσϑΥϧτϖʔδʣͷΈฦ͢ɺ ͱ͍͏Α͏ͳڍಈͷมߋ͕ൃੜͯ͠͠·͏͔Β • ϦΫΤετɿpage_sizeͱpage_token
 Ϩεϙϯεɿnext_page_token
11. ଞ • *Ͱ͸ͳ͘-Λ࢖͍·͠ΐ͏ • URLΤεέʔϓͷ౎߹্ • ϦιʔεͷҰ෦ͷϑΟʔϧυ͚ͩฦͤΔΑ͏ʹ͢Δͱศར • ϦιʔεΛfullͰ͸ͳ͘basicͳ΋ͷ͚ͩड͚औΕΔΑ͏ʹ͢Δͱศར • APIυΩϡϝϯτͷ࡞Γํ • ͳͲͳͲɾɾɾ
12. ·ͱΊ • RESTfulΛਪ঑͍ͯ͠Δ͕௚ײతͳઃܭΛॏࢹ • ෳ਺αʔϏεͰ࢓༷͕ࠞ୙͠ͳ͍Α͏ʹɺϖʔδωʔγϣϯ ͳͲϧʔϧ͕ݫ֨ʹܾ·͍ͬͯΔ • ࢓༷ͱυΩϡϝϯτ͸protoϑΝΠϧͰ؅ཧ • APIઃܭͷࢿྉͱͯ͠े෼·ͱ·͍ͬͯͯ࢖͑ͦ͏
13. https://speakerdeck.com/hirak/mercariday2017-api
14. • LSUDs • ͖Ε͍ͳAPI • SSKDs • ࣮૷଎౓ʼඒ͠͞ • վम͠·͘ΕΔઃܭ