TypeSpec & Orvalでの自動生成が けっこう便利だった話

自動生成はいろいろ便利だ！

Transcript

1. TypeSpec & Orvalでの自動生成が けっこう便利だった話 千株式会社 高倉 輝
2. 自己紹介
 千株式会社 システム開発部 
 高倉　輝 (secobaka)
 
 GitHub: https://github.com/secobaka
 Qiita: https://qiita.com/secobaka
 
 趣味: 映画・アイドル・漫才
 youtube: https://www.youtube.com/@友を失った夜

3. なんの話？ - 自動生成が便利だった話 - TypeSpec→API仕様書 - Orval→クライアントコード
4. TypeSpec - Microsoft製 - API仕様の定義に特化したDSL - TypeSpec(.tsp)で記述したものをOpenAPI(.yaml)に変換できる
6. TypeSpecの利点 - 記述が簡潔 - TSライクな記述でAPI仕様書を定義できる - ファイルの分割が可能 - OpenAPI→TypeSpecの移行が可能 - ツールを利用することで既存の API仕様書からTypeSpecへの移行をすることも可能 - バックエンドコードの自動生成やテストにも利用できる - 例) PHP - spectator - API仕様書で定義したスキーマと実際のコードで実装している型が一致しているかをテ ストすることができる
7. Orval - API仕様書から、クライアントコードや型定義を自動生成できる - Request, Responseの型定義の生成 - 型安全の保証 - クライアントコードの生成 - データフェッチライブラリ (TanstackQueryなど)やHttpクライアント(fetchなど)を選択可能
8. Orvalの利点 - 手動コーディングの削減 - API利用の際のコードの実装にかかる時間を削減できる - 型安全性の保証 - APIの変更が型エラーとして検知できる - 記述の標準化 - クライアントコードは自動生成されるため、一貫したフォーマットで記述ができる - クライアントコード以外も生成できる - MSWのMockの生成 - 開発段階、テスト、Storybookなどでの利用が可能 - Zodのobjectの生成 - バリデーション時の利用が可能
9. まとめ 自動生成けっこう便利だ！