Type Spec と Go（gin） で作るTypeSafeな web api/Craete type safe web api with typespec and go

ゆる勉強会 in 新宿御苑 #2
で発表させていただいた資料です！

https://engineers-anime.connpass.com/event/374534/

Transcript

1. Type Spec と Go（gin） で作るTypeSafeな web api ヲクラ @3l4I5

2. 自己紹介
 3l4i5 3l4l5 - クロスマート株式会社
 - 請求書チーム
 - テックリード
 - バックエンドエンジニア
 - すき
 - 🎷響けユーフォニアム
 - 🤖SSSS.GRIDMAN
 - 🎸ぼっち・ざ・ろっく
 - 🐧宇宙よりも遠い場所
 往蔵隆成(ヲクラ)
3. Web APIを作る時に考えること • リクエストのバリデーションを楽に書きたい • swagger.yaml書きたくないけど、swagger.yamlはほしい（わがまま） • バックエンドのcontroller層でも型safeに開発したい • （Go書けるようになりたいのでGoで書きたい）
4. リクエストのバリデーション楽に書きたい やだ！！！！！
5. Web APIを作る時に考えること • リクエストのバリデーションを楽に書きたい • swagger.yaml書きたくないけど、swagger.yamlはほしい（わがまま） • バックエンドのcontroller層でも型safeに開発したい • （Go書けるようになりたいのでGoで書きたい） FastAPI（Python） Nest.js（TypeScript/JavaScript) Micronaut(Kotlin) で、コードで型定義 → OpenAPI 仕様書生成可能
6. コードで型＋バリデーション定義 OpenAPI 仕様書
7. バックエンド バリデーション＋型のコード生成 OpenAPI 仕様書 何か
8. バックエンド バリデーション＋型のコード生成 OpenAPI 仕様書 TypeSpec
9. バックエンド バリデーション＋型のコード生成 OpenAPI Specification TypeSpec Swagger書かなくて良い！ ＋ バリデーション書かなくて良い！ ＋ Gin対応！
10. TypeSpecとは？ • TypeScriptのような書き方で APIのinterfaceを定義できる • TypeSpecで定義された記述を OpenAPI 仕様書に変換できる
11. TypeSpecとは？ “/stores”に対して • query paramでリクエストした場合は Storeのリストを返す • path paramでリクエストした場合は Store単体を返す
12. TypeSpecとは？ “/stores”に対して • query paramでリクエストした場合は Storeのリストを返す • path paramでリクエストした場合は Store単体を返す 入れ子のオブジェクトも 簡単に表現
13. TypeSpecの記述 Oapi.ymlの記述 変換！
14. TypeSpecの記述 Oapi.ymlの記述 変換！ 圧倒的に楽！🎉
15. バックエンド バリデーション＋型のコード生成 OpenAPI 仕様書 TypeSpec 今の話
16. OpenAPI 仕様書 TypeSpec 今度こっち バックエンド バリデーション＋型のコード生成
17. • OpenAPI 仕様書からGoのコードを生成 できる • ginをはじめとした、様々な GoのWeb APIのcontroller層のコード を生成 OpenAPI Specificationからのコード生成
18. 詳しくは割愛（ドキュメントを参照ください） • OpenAPI仕様書で定義した型を元に バリデーションコード レスポンスの型 を生成 • レスポンスには勝手にstatus codeをつけてくれる • errを返せば勝手に500 errorとして解釈してくれる → 至れり尽くせり！ oapi-codegen
19. バックエンド バリデーション＋型のコード生成 OpenAPI 仕様書 TypeSpec TypeSpec　Cli oapi-codegen
20. バックエンド バリデーション＋型のコード生成 OpenAPI 仕様書 TypeSpec TypeSpec　Cli oapi-codegen フロントエンド クライアント・型生成 orval / openapi-typescript
21. バックエンド バリデーション＋型のコード生成 OpenAPI 仕様書 TypeSpec TypeSpec　Cli oapi-codegen フロントエンド クライアント・型生成 orval / openapi-typescript 一気通貫の Type safe な web 開発！💪
22. 宣伝！ LT会やるよ〜　来てね〜