OpenAPIことはじめ - Speaker Deck

Tweet

Tweet

Slide 1

Slide 1 text

OpenAPI͜ͱ͸͡Ί ٕҭCAMP 2021/09/24 @sun-yryr / גࣜձࣾΏΊΈ

Slide 2

Slide 2 text

ΏΔΏΔ / sun-yryr / @taittide w גࣜձࣾΏΊΈ৽ଔೖࣾ w 4FSWFSTJEF&OHJOFFS 1)1 /PEFKT ΍ͬͯ·͢ɻ GitHub Twitter ܦྺ ޷͖ͳ͜ͱ w 4XJGU 4FSWFSTJEF $*$% w 75VCFS taittide sunyryr

Slide 3

Slide 3 text

΋͘͡ • OpenAPI / Swaggerͱ͸ • ͳͥOpenAPIΛ࢖͏ͷ͔ • OASͷߏ଄ • OpenAPI͔Βίʔυͷࣗಈੜ੒ʹ͍ͭͯ

Slide 4

Slide 4 text

OpenAPI / Swaggerͱ͸ • REST APIͷهड़ϑΥʔϚοτ • yaml or jsonͰهड़Ͱ͖Δ • Ұੲલ·Ͱ͸Swagger Speci fi cation͕ଘࡏ͍ͯͨ͠   ͜ΕΛݩʹ֦ு͞Εͯݱࡏ࢖ΘΕ͍ͯΔͷ͕OpenAPI(Speci fi cation) • ݱࡏόʔδϣϯ3

Slide 5

Slide 5 text

OpenAPI / Swaggerͱ͸ • OAS(OpenAPI Speci fi cation) Λิॿ͢Δπʔϧͷ૯শ • Swagger Editor (هड़ɾม׵) • Swagger UI (දࣔ) • Swagger Codegen (ίʔυੜ੒)

Slide 6

Slide 6 text

ͳͥ࢖͏ͷ͔ • ࢓༷͕ݟ΍͍͢ • ΄΅ελϯμʔυʹͳ͖͍ͬͯͯΔͷͰڞ༗͕͠΍͍͢ • ίʔυͷࣗಈੜ੒͕ศར͗͢Δ • ϓϩάϥϜͰѻ͍΍͍͢

Slide 7

Slide 7 text

ͳͥ࢖͏ͷ͔ • ࢓༷͕ݟ΍͍͢ • ΄΅ελϯμʔυʹͳ͖͍ͬͯͯΔͷͰڞ༗͕͠΍͍͢ • ίʔυͷࣗಈੜ੒͕ศར͗͢Δ • ϓϩάϥϜͰѻ͍΍͍͢

Slide 8

Slide 8 text

ͳͥ࢖͏ͷ͔ • ࢓༷͕ݟ΍͍͢ • ΄΅ελϯμʔυʹͳ͖͍ͬͯͯΔͷͰڞ༗͕͠΍͍͢ • ίʔυͷࣗಈੜ੒͕ศར͗͢Δ • ϓϩάϥϜͰѻ͍΍͍͢

Slide 9

Slide 9 text

ͳͥ࢖͏ͷ͔ • ࢓༷͕ݟ΍͍͢ • ΄΅ελϯμʔυʹͳ͖͍ͬͯͯΔͷͰڞ༗͕͠΍͍͢ • ίʔυͷࣗಈੜ੒͕ศར͗͢Δ • ϓϩάϥϜͰѻ͍΍͍͢

Slide 10

Slide 10 text

ͳͥ࢖͏ͷ͔ • ࢓༷͕ݟ΍͍͢ • ΄΅ελϯμʔυʹͳ͖͍ͬͯͯΔͷͰڞ༗͕͠΍͍͢ • ίʔυͷࣗಈੜ੒͕ศར͗͢Δ • ϓϩάϥϜͰѻ͍΍͍͢

Slide 11

Slide 11 text

https://fortee.jp/phpcon-2021/proposal/5a58e077-6de6-453a-abff-adbe24cc3156

Slide 12

Slide 12 text

OASͷߏ଄

Slide 13

Slide 13 text

• openapi (όʔδϣϯ) • info (৘ใ) • servers (ϕʔεURL) • paths (ΤϯυϙΠϯτ) • components (࠶ར༻ՄೳͳΦϒδΣΫτ) • tags (λά)

Slide 14

Slide 14 text

info ར༻ن໿

Slide 15

Slide 15 text

servers

Slide 16

Slide 16 text

paths

Slide 17

Slide 17 text

components

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

tags

Slide 20

Slide 20 text

OpenAPI͔Βίʔυͷࣗಈੜ੒

Slide 21

Slide 21 text

Swagger Codegen language: dart, csharp, go, java, python, ruby, php, swift5, typescript-fetch, javascript, etc…

Slide 22

Slide 22 text

Swagger Codegen ੜ੒͞ΕΔϑΝΠϧ ར༻αϯϓϧ

Slide 23

Slide 23 text

Swagger Codegen service/AService.js

Slide 24

Slide 24 text

OpenAPIͷΤίγεςϜͰ ։ൃΛศརʹ͍͖ͯ͠·͠ΐ͏ʂ

Slide 25

Slide 25 text

͓͠·͍