OpenAPI→TypeScript型定義生成ツール
ローカル処理OpenAPI 3.0 / SwaggerのJSON仕様書から、型安全なTypeScriptのinterfaceおよびtype定義を生成します。
使い方と処理基準
OpenAPI 3.0 / SwaggerのJSON仕様書から、型安全なTypeScriptのinterfaceおよびtype定義を生成します。
ツールの処理はブラウザ内で行われます。計算・変換の共有リンクを作成すると値がURLに含まれます。アカウント・アクセス解析・広告の情報はプライバシーポリシーをご確認ください。
処理制限
- 最大入力文字数: 100,000文字
バックエンドのAPI仕様からフロントエンドの型をすばやく作るときに使います。JSON形式のOpenAPIを貼り付けると、スキーマごとにinterfaceを作ります。
components.schemasだけを変換します。パス（paths）ごとのリクエスト・レスポンスの型は作りません。YAMLの仕様は先に「YAML → JSON」で変換してください。
できること
- スキーマ → interface
- components.schemasの各スキーマをexport interfaceに。
- 任意のプロパティ
- requiredにないプロパティに?を付けます。
OpenAPI→TypeScript型定義生成ツールの使い方
- 1OpenAPIを貼り付けJSON形式の仕様を貼り付けます。
- 2結果を確認作られた型を見ます。
- 3コピーtypes.tsなどに貼ります。
活用例
Userスキーマ
入力: {"components":{"schemas":{"User":{"type":"object","required":["id"],"properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}}
結果: export interface User {
"id": number;
"name"?: string;
}
主な利用シーン
- API仕様からフロントエンドの型を作るとき
- 仕様とコードの型を照らし合わせるとき
よくある質問 (FAQ)
integerもnumberになりますか？
はい。TypeScriptには整数の型が別にないため、integerとnumberをどちらもnumberにします。