Orval - 🐾 Nekonote

Orval

https://gyazo.com/baffd66999036bc27cdb725bb8d158eb

Generate client with appropriate type-signatures

OpenAPI v3 または Swagger 用の YAML によるAPI定義から、型定義とAPIクライアントを自動生成する仕組み

TypeScript で本体が構築されており、コード生成に際して Java などの外部依存を必要としないことが特徴。

生成に際しては $ref による YAML の外部参照が存在しないことが必要になるので、定義を個別ファイルで分割している場合はコード生成前に Redocly などを使用して定義をひとまとめにすると良い。

クライアントコードは基本的に TanStack Query と Axios を使用したものが出力される。

React、Vue、Angular、Svelte 用のAPIクライアントが生成できる。

付帯して、MSW によるモックコードと、Zod によるスキーマ情報の生成も可能。