Overview: Swift OpenAPI Generator

Transcript

1. @ojun Overview: Swift OpenAPI Generator
2. ࣗݾ঺հ
3. ࣗݾ঺հ • name: ojun • 2023೥৽ଔೖࣾ • iOSΤϯδχΞ
4. ࠓ೔ൃද͢Δ͜ͱ
5. ࠓ೔ൃද͢Δ͜ͱ • Swift OpenAPI Generator ͷ overview • αʔόଆ & ΫϥΠΞϯτଆͷ࣮૷ • ΞϓϦ։ൃͷࡍʹඞཁʹͳΔ͜ͱ • APIClientͷӅṭ • Headerͷ஫ೖ • Middlewareͷਂ۷Γ
6. • Swift OpenAPI Generator ͷ overview • αʔόଆ & ΫϥΠΞϯτଆͷ࣮૷ • ΞϓϦ։ൃͷࡍʹඞཁʹͳΔ͜ͱ • APIClientͷӅṭ • Headerͷ஫ೖ • Middlewareͷਂ۷Γ ࠓ೔ൃද͢Δ͜ͱ “https://developer.apple.com/videos/play/wwdc2023/10171/"ΑΓҾ༻
7. Swift OpenAPI Generator ͱ͸ʁ
8. Swift OpenAPI Generator ͱ͸ʁ • AppleʹΑͬͯ։ൃ͞Εͨ Swift Package Plugin • OpenAPIυΩϡϝϯτ͔ΒSwiftͷΫϥΠΞϯτ͓ΑͼαʔόʔίʔυΛ ੜ੒͢Δ͜ͱ͕Մೳ • OpenAPI ͷ 3.0 ͱ 3.1 Ͱಈ࡞͢Δ
9. OpenAPIͷॏཁੑ • OpenAPI͸ɺHTTPϕʔεͷAPIΛهड़͢ΔͨΊͷۀքඪ४ • JSON·ͨ͸YAMLͰॻ͔ΕͨOpenAPIυΩϡϝϯτʹΑΓɺAPIͷߏ଄ Λ໌֬ʹ͠ɺҟͳΔπʔϧͰͷࣗಈԽ͕ՄೳͱͳΔ
10. Swift OpenAPI Generatorͷ໨త • APIݺͼग़͠ͰඞཁͱͳΔ͍ΘΏΔ”ّࣜతͳίʔυ”Λࣗಈੜ੒͢Δ͜ͱ • ίʔυ͸Ϗϧυ࣌ʹੜ੒͞Εɺ͔ͭɺAPIυΩϡϝϯτͱৗʹಉظ͢Δ ͷͰϦϙδτϦʹίʔυΛؚΊΔඞཁ͕ͳ͘ͳΔ ࣗಈੜ੒
11. Swift OpenAPI Generatorͷ໨త • APIݺͼग़͠ͰඞཁͱͳΔ͍ΘΏΔ”ّࣜతͳίʔυ”Λࣗಈੜ੒͢Δ͜ͱ • ίʔυ͸Ϗϧυ࣌ʹੜ੒͞Εɺ͔ͭɺAPIυΩϡϝϯτͱৗʹಉظ͢Δ ͷͰϦϙδτϦʹίʔυΛؚΊΔඞཁ͕ͳ͘ͳΔ • ख࡞ۀʹΑΔAPIؔ࿈ίʔυͷهड़͔Βղ์͞ΕɺΑΓޮ཰త͔ͭਖ਼֬ ʹϓϩδΣΫτΛਐΊΔΑ͏ʹͳΔ🎉
12. Swift OpenAPI Generatorͷಛ௃
13. Swift OpenAPI Generatorͷಛ௃ • Swift Package Plugin • Ϗϧυ࣌ʹҎԼ͕ίʔυੜ੒͞ΕΔ • Type safe ͳϓϩύςΟ • ೖग़ྗͷΤϯίʔυɾσίʔυॲཧ • ϦΫΤετͷੜ੒
14. αʔόଆͷ࣮૷
15. αʔόଆͷ࣮૷ • ΫϥΠΞϯτଆΛಈ࡞ͤ͞ΔͨΊʹVaporΛར༻ͨ͠ϩʔΧϧͰಈ࡞͢ ΔαʔόΛ࣮૷͢Δ
16. OpenAPIͷ಺༰ • શ༰͸ӈͷ௨Γ
17. OpenAPIͷ಺༰ • OpenAPIͷόʔδϣϯΛ هड़ • info͓Αͼserversͷ಺༰Λ هड़
18. OpenAPIͷ಺༰ • v1/welcome_message Λ࣮૷ • parameter ͱͯ͠ {name: String} Λड͚औΔ • response ͱͯ͠ PixivAppNightMessageΛ ฦ͢
19. OpenAPIͷ಺༰ • PixivAppNightMessage ͸ {message: String}ΛؚΉ
21. BuildΛߦ͏ͱҎԼͷίʔυ͕ࣗಈੜ੒͞ΕΔ
22. APIProtocolʹ४ڌͨ͠ߏ଄ମΛ࣮૷͢Δ
23. APIProtocolʹ४ڌͨ͠ߏ଄ମΛ࣮૷͢Δ
24. APIProtocolʹ४ڌͨ͠ߏ଄ମΛ࣮૷͢Δ return ͕ෳࡶʹͳΔ
25. APIProtocolʹ४ڌͨ͠ߏ଄ମΛ࣮૷͢Δ
26. • ࣮ߦ ͢Δ͜ͱͰ ϩʔΧϧͷαʔό͕ ্ཱ͕ͪΔ 🎉 APIProtocolʹ४ڌͨ͠ߏ଄ମΛ࣮૷͢Δ
27. αʔόଆͷ࣮૷׬੒ 🎉
28. Clientଆͷ࣮૷
29. OpenAPIͷ࣮૷ • ϩʔΧϧͰͷ։ൃͳͷͰ ઐ༻ͷurlΛ௥Ճ͢Δ
31. Clientଆͷ࣮૷ 1. ClientͷॳظԽ 2. APIΛୟ͘ 3. responseͷղੳ
32. Clientଆͷ࣮૷ 1. ClientͷॳظԽ 2. APIΛୟ͘ 3. responseͷղੳ
33. Clientଆͷ࣮૷ 1. ClientͷॳظԽ 2. APIΛୟ͘ 3. responseͷղੳ
34. Clientଆͷ࣮૷ 1. ClientͷॳظԽ 2. APIΛୟ͘ 3. responseͷղੳ ࣮ߦ͢Δͱʮojun͞Μɺpixiv App Night΁Α͏ͦ͜!ʯ͕ग़ྗ͞ΕΔ
35. Client ଆͷ࣮૷׬੒ 🎉
36. Swift OpenAPI GeneratorͷӅṭ
37. Swift OpenAPI GeneratorͷӅṭ • ݱࡏͷ࣮૷Ͱ͸ɺར༻ଆ͕ Swift OpenAPI Generator ʹґଘͨ͠ϝιο υΛ௚઀ݺͼग़͍ͯ͠Δ → ར༻ऀ͕Generatorͷ࣮૷ͷৄࡉΛ஌Δඞཁ͕͋Δ • ͜Εղܾ͢ΔͨΊʹɺ৽͍͠ߏ଄ମΛಋೖ͠ɺSwift OpenAPI Generator ͷػೳΛϥοϓ͢Δ • ͜ΕʹΑΓSwift OpenAPI Generator΁ͷ௚઀తͳґଘؔ܎͕Ӆṭ͞Εɺ APIͷ࢖༻͕ΑΓγϯϓϧʹͳΔ
38. Swift OpenAPI GeneratorͷӅṭ • APIClientΛఆٛ͢Δ
39. Swift OpenAPI GeneratorͷӅṭ • clientΛఆٛ͢Δ
40. Swift OpenAPI GeneratorͷӅṭ • clientΛఆٛ͢Δ • any APIProtocolͳclientΛ ఆٛ͠init಺ͰॳظԽ͢Δ
41. Swift OpenAPI GeneratorͷӅṭ • clientΛఆٛ͢Δ • any APIProtocolͳclientΛ ఆٛ͠init಺ͰॳظԽ͢Δ • APIͷ਺͚ͩϝιουΛ࡞੒͠ ͦͷதͰAPIΛୟ͘
42. Swift OpenAPI GeneratorͷӅṭ • ෳ਺ͷ initializer Λఏڙ͠ έʔεʹԠͯ͡ݺͼग़͢ initializer Λ੾Γସ͑Δ ͜ͱͰ testable ͳ࣮૷ ʹͳΔ
43. Ӆṭ׬੒ 🎉
44. Headerͷ௥Ճ
45. Headerͷ௥Ճ • APIΛୟ͘ࡍʹHeaderʹରͯ͠ ༷ʑͳ஋Λ௥Ճ͢Δ͜ͱ͕͋Δ • Swift OpenAPI Generatorͷ ClientΛར༻͢Δࡍ΋HeaderΛ ௥Ճ͢Δඞཁ͕͋Δ
46. ClientMiddleware
47. ClientMiddleware
48. ClientMiddleware
49. ClientMiddleware
50. ClientMiddleware
51. ClientMiddleware
52. ClientMiddleware
53. ClientMiddleware
54. ࣮ࡍʹ࡞ͬͯΈΑ͏ʂ
63. HTTPField.NameΛࢦఆ͢Δ
64. HTTPField.Nameͱ͸ʁ
67. HTTPField.NameΛࢦఆ͢Δ
69. ΧελϜͳHTTPField.NameΛࢦఆ͍ͨ͠ • σϑΥϧτͰ͸“Appp-OS”΍ “App-Version”͸ଘࡏ͍ͯ͠ͳ͍
70. • σϑΥϧτͰ͸“Appp-OS”΍ “App-Version”͸ଘࡏ͍ͯ͠ͳ͍ • → ࣗ࡞͢Δඞཁ͕͋Δ ΧελϜͳHTTPField.NameΛࢦఆ͍ͨ͠
73. ຖճม਺ʹೖΕΔͷ͕໘౗
74. ConsumingΩʔϫʔυΛ෇༩͢Δ ͜ͱͰճආͰ͖Δ
75. ෇༩Ͱ͖Δͷ͕ίϯύΠϥͷόά Ͱ͋ΔՄೳੑ͸͋Δ ConsumingΩʔϫʔυΛ෇༩͢Δ ͜ͱͰճආͰ͖Δ
76. HeaderInjectionMiddleware ͷ׬੒ 🎉
77. ࡞੒ͨ͠ Middleware ͷࢦఆ
80. Middleware ͷਂ۷Γ
82. Transport ͱ Middlewareͷҧ͍͸ʁ
83. Transport • ࣮ࡍʹωοτϫʔΫΛ࢖༻͠ɺHTTPૢ࡞Λ࣮ߦ͢Δ(جຊͱͳΔ)HTTP ϥΠϒϥϦΛந৅Խ͢Δ • ҎԼͷ2ͭͷ৔߹͸ custom transport ͷ࣮૷Λݕ౼͢Δͱྑ͍ • ޷ΈͷHTTPϥΠϒϥϦʹରԠ͢ΔΫϥΠΞϯττϥϯεϙʔτ͕·ͩ ଘࡏ͠ͳ͍৔߹ • ςετͰ௝͍͠ωοτϫʔΫ৚݅ΛγϛϡϨʔτ͢Δඞཁ͕͋Δ৔߹
84. ClientMiddleware • transport ʹҾ͖౉͞ΕΔલͷϦΫΤετͱɺtransport ʹΑͬͯ౉͞Ε ͨޙͷϨεϙϯεΛಡΈऔΓɺมߋ͢Δ͜ͱ͕Ͱ͖Δ • HTTPϦΫΤετͱϨεϙϯεΛड͚औΔ͕ɺࣗ਎ͰHTTPૢ࡞Λ࣮ߦ͢ Δ੹೚͸ଘࡏ͠ͳ͍ • Ώ͑ʹɺϛυϧ΢ΣΞ͸௥Ճͷ next ύϥϝʔλΛऔΓɺHTTPίʔϧ Λϛυϧ΢ΣΞελοΫͷઌ಄ʹ͋Δ transport ʹҕৡ͢Δ
85. ClientMiddleware • ೝূɺϩάه࿥ɺϝτϦΫεɺτϨʔγϯάɺΧελϜϔομͷ஫ೖΛ ߦ͏͜ͱʹద͍ͯ͠Δ • ·ͨɺҎԼͷΑ͏ͳςετʹ΋ద͍ͯ͠Δ • ࣮ࡍͷαʔόʔ΁ͷϦΫΤετ࣌ʹϥϯμϜͳࣦഊΛ஫ೖ • ͦͷঢ়گΛར༻ͯ͠ɺϦτϥΠ΍ΤϥʔϋϯυϦϯάͷϩδοΫΛς ετ͢Δ͜ͱ
86. ॲཧͷॱং ʢAPIϦΫΤετૹ৴࣌ʣ
87. ॲཧͷॱংʢAPIϦΫΤετૹ৴࣌ʣ • [Middleware] ͷ্͔Β࣮ߦ • ׬ྃޙɺtarnsport͕࣮ߦ͞ΕΔ
90. 1 2
91. 1 2 3
92. 1 2 3 4
93. 1 2 3 4 OpenAPIRuntime/Interface/UniversalClient.swift ಺Ͱ࣮૷͞ΕͯΔ
94. Ҿ਺ʹnext͕ଘࡏͨ͠ཧ༝ͱ return ͢Δࡍʹ next Λࢦఆ͍ͯͨ͠ཧ༝͕ݟ͑ͯ͘Δ
95. ॲཧͷॱং ʢϨεϙϯεड৴࣌ʣ
96. ॲཧͷॱংʢϨεϙϯεड৴࣌ʣ • ࠷ॳʹtarnsport͕࣮ߦ͞ΕΔ • ׬ྃޙɺ[Middleware] ͷԼ͔Βॱ࣮࣍ߦ͞ΕΔ • * Կ౓͔ࢼ͕ͨ͠ɺϨεϙϯεड৴࣌ʹͦ΋ͦ΋Middleware͕࣮ߦ ͞Εͳ͔ͬͨ
97. ·ͱΊ
98. ·ͱΊ • Swift OpenAPI Generator Λར༻͢Δ͜ͱͰɺAPIݺͼग़͠΍αʔόʔ࣮ ૷ʹඞཁͳίʔυΛࣗಈੜ੒͠ɺ։ൃऀ͕ख࡞ۀΛলུͯ͠ޮ཰త͔ͭ ਖ਼֬ʹϓϩδΣΫτΛਐΊΒΕΔΑ͏ʹͳΔ • Generatorͷ࣮૷ͷৄࡉΛӅͨ͢Ίʹclient෦෼Λϥοϓ͢Δ
99. ·ͱΊ • ClientMiddlewareΛར༻ͯ͠HeaderΛࢦఆ͢Δ • ΧελϜͳHeader͸HTTPField.NameΛ֦ு͢Δ • MiddlewareΛ࢖͏͜ͱͰೝূɺϩάه࿥ͳͲ༷ʑͳ͜ͱΛߦ͑Δ • transportͱmiddlewareͷҧ͍Λཧղ͠ɺద੾ͳΧελϜߏ଄ମΛ࡞੒ ͢Δ͜ͱ͕ॏཁ
100. ͋Γ͕ͱ͏͍͟͝·ͨ͠ʂ