openapi-ts/openapi-typescript

これは何？

主な機能

• 01静的なOpenAPI 3スキーマをTypeScriptの型定義に変換します。
• 02生成されたスキーマ型に基づいて型付けされたfetchクライアント、openapi-fetchを提供します。
• 03クライアントからの呼び出しとAPI定義の不一致をコンパイル時に検出します。
• 04プロジェクトのトピック情報に示されているとおり、OpenAPI 3.1をサポートします。

ユースケース

• バックエンドのOpenAPIファイルから、フロントエンドアプリ用の型付きAPIクライアントモデルを生成する。
• 既存のREST API向けに型安全なfetchクライアントを構築する。
• CIで、変更されるAPIスキーマにクライアントの型を同期させる。

クイックスタート

1. 1

   npmからopenapi-typescriptをインストールする

   npm i -D openapi-typescript typescript
2. 2

   OpenAPIスキーマから型を生成する

   npx openapi-typescript https://petstore3.swagger.io/api/v3/openapi.json -o ./petstore.d.ts

トピック

よくある質問

openapi-typescript とは？

OpenAPI 3スキーマからTypeScript型を生成し、それらの型に基づく型安全なfetchクライアントも提供します。 openapi-typescriptは、TypeScriptでOpenAPIスキーマを扱うための2つのパッケージを含むモノレポです。メインのパッケージであるopenapi-typescriptは、静的なOpenAPI 3スキーマをTypeScriptの型定義に変換します。これにより、リクエストパス、パラメーター、レスポンスボディを手書きする代わりに、コンパイル時にチェックできます。

openapi-typescript は無料で使えますか？ライセンスは？

openapi-typescript は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

openapi-typescript は今もメンテナンスされていますか？

半年以内に更新あり。openapi-typescript の最終コミットは 2026年9月25日 です。

openapi-typescript は何に使えますか？

バックエンドのOpenAPIファイルから、フロントエンドアプリ用の型付きAPIクライアントモデルを生成する。 既存のREST API向けに型安全なfetchクライアントを構築する。 CIで、変更されるAPIスキーマにクライアントの型を同期させる。

openapi-typescript のインストール方法は？

npmからopenapi-typescriptをインストールする: npm i -D openapi-typescript typescript OpenAPIスキーマから型を生成する: npx openapi-typescript https://petstore3.swagger.io/api/v3/openapi.json -o ./petstore.d.ts

openapi-typescript はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/openapi-ts/openapi-typescript