Postmanを利用したAPI開発/postman-tutorial

Transcript

1. ਔՊ ढ़੖ PostmanΛར༻ͨ͠API։ൃ 
2. ໨࣍  • ࠓճ࿩͢಺༰ • Postmanʹ͍ͭͯ • Postmanͷ۩ମతͳ࢖͍ํ • ஌͓ͬͯ͘ͱศརͳTIPS • ·ͱΊ
3. ໨࣍  • ࠓճ࿩͢಺༰ • Postmanʹ͍ͭͯ • Postmanͷ۩ମతͳ࢖͍ํ • ஌͓ͬͯ͘ͱศརͳTIPS • ·ͱΊ
4. • ʮAPI։ൃͬͯଞͷਓ͸Ͳ͏΍ͬͯ΍͍ͬͯΔͷʁʯ
 • ʮAPI։ൃΛ͢Δ্Ͱඞཁʹͳͬͯ͘ΔφϨοδͱ͔͋Δʁʯ  ͲͷΑ͏ʹAPI։ൃΛ͍ͯ͠Δ͔ڞ༗ API։ൃͰར༻͍ͯ͠ΔPostmanʹ͍ͭͯ࿩͠Λ͠·͢ ΋͠ɺAPI։ൃΛ͢Δ্Ͱศརͳπʔϧɾϊ΢ϋ΢ͳͲ͋Ε͹ڭ͑ ͯ΋Β͑Δͱ͏Ε͍͠Ͱ͢
5. ໨࣍  • ࠓճ࿩͢಺༰ • Postmanʹ͍ͭͯ • Postmanͷ۩ମతͳ࢖͍ํ • ஌͓ͬͯ͘ͱศརͳTIPS • ·ͱΊ
6. • ࠨ্͔ΒAPIͷొ࿥͕Ͱ͖Δ • ࠨαΠυόʔʹAPIͷҰཡ • APIͷ࣮ߦ݁Ռ͕ը໘தԝʹ
 දࣔ͞ΕΔ  Postmanͷશମ૾ʹ͍ͭͯ
7. • Params • ύϥϝʔλʔ෇͖Ͱ
 ϦΫΤετૹΔͱ͖ʹར༻ • Authorization • ೝূ͕ඞཁͳAPIͷ࣌ʹར༻ • Headers • Content-Type΍ɺAcceptΛ ࢦఆ͢Δͱ͖ʹར༻ • Body • JSONΛهड़͢Δͱ͜Ζ  APIϦΫΤετͷৄࡉʹ͍ͭͯ
8. ໨࣍  • ࠓճ࿩͢಺༰ • Postmanʹ͍ͭͯ • Postmanͷ۩ମతͳ࢖͍ํ • ஌͓ͬͯ͘ͱศརͳTIPS • ·ͱΊ
9. 1. HTTPϝιουͱ
 ΤϯυϙΠϯτΛࢦఆ͢Δ
 2. ʰSendʱͰ࣮ߦ
 3. APIͷϨεϙϯε͕දࣔ͞ΕΔ  GETϝιουʢγϯϓϧͳϦΫΤετʣ
10. 1. ParamsΛબ୒
 2. Key, ValueΛηοτ͢Δͱ
 ΫΤϦύϥϝʔλͱͯ͠
 ௥Ճ͞ΕΔ  GETϝιουʢύϥϝʔλ෇͖ͷϦΫΤετʣ
11. 1. ʰBodyʱΛબ୒
 2. ʰrawʱબ୒͠ɺJSONܗࣜΛ ࢦఆ͢Δͱɺ
 JSONͷϦΫΤετϘσΟ͕
 ࡞੒Ͱ͖Δ
 3. Header͸key, valueͰηοτ Λ͢Δ  POSTϝιουʢϘσΟɺϔομʔ෇͖ϦΫΤετʣ
12. 1. ʰBodyʱΛબ୒
 2. ʰform-dataʱΛࢦఆ͢Δͱɺ ը૾ΞοϓϩʔυͷΑ͏ͳ
 ϦΫΤετΛૹΔ͜ͱ͕Մೳ  POSTϝιουʢϑΥʔϜΛར༻ͨ͠ϦΫΤετʣ
13. ໨࣍  • ࠓճ࿩͢಺༰ • Postmanʹ͍ͭͯ • Postmanͷ۩ମతͳ࢖͍ํ • ஌͓ͬͯ͘ͱศརͳTIPS • ·ͱΊ
14.  Basicೝূ͕ඞཁͳ؀ڥʹରͯ͠API઀ଓ͢Δʹ͸ʁ ʰAuthorizationʱʹʰBasic Authʱͱ͍͏ೝূํ๏͕͋Γ·͢ɻ UsernameͱPasswordΛηοτ͢Ε͹BasicೝূΛύεͰ͖·͢ɻ
15.  ؀ڥ͝ͱʹϗετ໊ͳͲΛ੾Γସ͑Δํ๏͸ʁ ӈ্ͷࣃंΞΠίϯ͔Β؀ڥ͝ͱʹม਺ΛఆٛͰ͖·͢ɻ ྫ͑͹ɺHOST_NAMEΛ؀ڥ͝ͱʹఆٛ͢Ε͹ɺ
 ʰ{{HOST_NAME}}/api/…ʱͷΑ͏ͳϦΫΤετ͕࣮ߦՄೳʹͳΓ·͢
16.  ଞਓͷPostmanͷઃఆΛΠϯϙʔτ͢Δํ๏͸ʁ Postmanʹ͸ઃఆͷΤΫεϙʔτ/Πϯϙʔτػೳ͕͋ΔͷͰɺ
 ΤΫεϙʔτͯ͠΋ΒͬͨσʔλΛΠϯϙʔτ͢Ε͹؀ڥߏங͕׬ྃɻ
17. ໨࣍  • ࠓճ࿩͢಺༰ • Postmanʹ͍ͭͯ • Postmanͷ۩ମతͳ࢖͍ํ • ஌͓ͬͯ͘ͱศརͳTIPS • ·ͱΊ
18. • API։ൃΛ͢Δࡍʹར༻͍ͯ͠ΔPostmanͷ঺հ • PostmanΛར༻͢Δ͜ͱͰೝূ΍ը૾ΞοϓϩʔυͳͲ
 ͷAPIϦΫΤετͷ࣮ߦ΋؆୯ʹͰ͖Δ • ΤΫεϙʔτɾΠϯϙʔτػೳΛར༻͢Δ͜ͱͰ
 ؀ڥߏங΋؆୯ʹͰ͖Δ  ·ͱΊ