Compiler APIを利用してAPI型定義ファイルからOpenAPI.jsonを作成する

by CommuneDevelopers

Slide 1

Slide 1 text

Compiler APIΛར༻ͯ͠ APIܕఆٛϑΝΠϧ͔Β  OpenAPI.jsonΛ࡞੒͢Δ TypeScript Developers Meetup   ʙϑϩϯτ͔ΒόοΫ·Ͱ TSʙ 2024/05/08

Slide 2

Slide 2 text

AGENDA 1. ࣗݾ঺հ 2. Communeͷٕज़ελοΫ 3. Communeʹ͓͚ΔAPIͷܕఆٛ 4. ࠷ۙͷ՝୊ 5. APIܕఆٛϑΝΠϧ͔ΒOpenAPI.jsonΛ࡞੒ 6. ࠓޙͷ՝୊ 7. ·ͱΊ

Slide 3

Slide 3 text

© Commune Inc. All rights reserved ֯ా෢ଂ (a.k.a. Buzo) Tech & Platform Software engineer Musashi Tsunoda ڈ೥ͷ8݄ʹίϛϡʔϯגࣜձࣾʹೖࣾɻ TypeScriptʹΑΔόοΫΤϯυɾϑϩϯτΤϯυ྆ ํͷ։ൃΛߦ͏ɻ ུ֓ SNS X: @buzou_muzou ࣗݾ঺հ ޷͖ͳ͜ͱ ݸਓ։ൃͱϘΫγϯά

Slide 4

Slide 4 text

Communeͷٕज़ελοΫ

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Communeʹ͓͚Δ APIͷܕఆٛ

Slide 8

Slide 8 text

Slide 9

Slide 9 text

࠷ۙͷ՝୊

Slide 10

Slide 10 text

Slide 11

Slide 11 text

OpenAPI.jsonΛ࡞Ζ͏

Slide 12

Slide 12 text

Slide 13

Slide 13 text

Compiler APIͱ͸

Slide 14

Slide 14 text

© Commune Inc. All rights reserved Compilier APIͱ͸ ● TypeScriptͷτϥϯεύΠϧ࣌ʹߦ͍ͬͯΔΑ͏ͳॲཧΛ  ݺͼग़͢͜ͱ͕Ͱ͖ΔAPI ● ίʔυΛந৅ߏจ໦(AST)ͱͯ͠ղੳ͕Ͱ͖Δ ● ίʔυͷม׵΍ࣗಈੜ੒ͳͲʹར༻͢Δ͜ͱ͕Ͱ͖Δ ● Web APIͰ͸ͳ͍ ● TypeScriptͷ։ൃݩ͕ެ։͍ͯ͠Δ  https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API

Slide 15

Slide 15 text

Compiler APIΛ࢖ͬͯ OpenAPI.jsonΛ࡞੒͢Δ

Slide 16

Slide 16 text

Slide 17

Slide 17 text

Slide 18

Slide 18 text

Slide 19

Slide 19 text

Slide 20

Slide 20 text

© Commune Inc. All rights reserved OpenAPI.jsonΛ࡞੒ foo: string “foo”: {“type”:”string”}, bar: number “bar”: {“type”:“number”} baz: { foo: string, bar: number } “baz”: { “type”: “object”, "properties": { “foo”: {“type”:”string”}, “bar”: {“type”:“number”} } } TypeScript OpenAPI.json

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Slide 25

Slide 25 text

Slide 26

Slide 26 text

ࠓޙͷ՝୊

Slide 27

Slide 27 text

© Commune Inc. All rights reserved ࠓޙͷ՝୊ ● Tsunaggerͷอक ● ୯७ͳΦϒδΣΫτ΍  ϓϦϛςΟϒͳܕఆٛͰ͸ͳ͍৔߹ͷରॲ ● ผͷํ๏ͷݕ౼ ○ APIܕఆٛΛzodͰߦ͍ɺzod-to-openapi౳  ֎෦ϥΠϒϥϦͰOpenAPI.jsonΛ࡞੒ ○ zod΁ͷҠߦظؒத͸TsunaggerʹΑΔOpenAPI.jsonΛ  ར༻͢Δ༧ఆ