openapi-typescriptについて

利用者

Bigcommerce: BigCommerce API 用の Node SDK
Budibase: 内部ツール、ワークフロー、および管理ダッシュボードを作成するためのローコードプラットフォーム
Fedora fmn: Fedora メッセージインフラストラクチャのツールと API
Fingerprint: 大規模なアプリケーション向けのデバイスフィンガープリンティング
Google Firebase CLI: Google Firebase プラットフォーム用の公式 CLI
GitHub Octokit: GitHub API の公式 SDK
Lotus: オープンソースの価格設定およびパッケージングインフラストラクチャ
Jitsu: モダンでオープンソースのデータ収集/データパイプライン
Medusa: デジタルコマースの構築ブロック
Netlify: モダンな開発プラットフォーム
Nuxt: 直感的な Vue フレームワーク
Relevance AI: AI チェーンの構築と展開
Revolt: オープンソースのユーザー優先チャットプラットフォーム
Spacebar: 無料でオープンソースの自ホスト可能な Discord 互換のチャット/音声/ビデオプラットフォーム
Supabase: オープンソースの Firebase 代替
Twitter API: Twitter API の公式 SDK

プロジェクトの目標

任意の有効な OpenAPI スキーマを TypeScript 型に変換できるようにすること。どんなに複雑なスキーマでも対応可能です。
生成される型は静的に解析可能で、実行時の依存関係がない（ただし、enums のような例外はあります）。
生成された型は、元のスキーマにできるだけ一致し、元の大文字形式などを保持します。
型の生成は Node.js だけで実行可能であり、（Java、Python などは不要）どんな環境でも実行できます。
ファイルからの OpenAPI スキーマのフェッチや、ローカルおよびリモートサーバーからのフェッチをサポートします。

比較

vs. swagger-codegen

openapi-typescript は、swagger-codegen の軽量で使いやすい代替手段として作成されており、Java ランタイムや OpenAPI サーバーを実行する必要はありません。また、大規模なクライアントサイドコードも生成しません。実際、openapi-typescript が生成するすべてのコードは、実行時の依存関係がない静的型 であり、最大のパフォーマンスと最小のクライアント負荷を実現します。

vs. openapi-typescript-codegen

openapi-typescript-codegen は、元の swagger-codegen の Node.js 代替手段ですが、実際には同じものです。openapi-typescript は、openapi-typescript-codegen と同様に、実行時の依存関係がない という利点を持っていますが、openapi-typescript-codegen は、スキーマの複雑さに応じて 250 kB 以上になるかなり大きなバンドルを生成する可能性があります。