# OpenAPIからTypeScriptへ

YAMLまたはJSON形式のOpenAPI 3またはSwagger 2.0ドキュメントからスキーマを読み取り、TypeScriptの型を生成します。components.schemas配下の各エントリー（Swagger 2.0ではdefinitions）が、エクスポートされたインターフェースまたは型エイリアスになります。$refによる相互参照は型名になり、null許容フィールドには| nullが付きます。

## よくある質問

### ドキュメントのどの部分が変換されますか？

OpenAPI 3のcomponents.schemas配下とSwagger 2.0のdefinitions配下にあるスキーマです。パス、パラメーター、レスポンスは型に変換されません。生成されたスキーマ型は、独自のリクエストやレスポンスのコードから参照してください。

### スキーマ名はどのように型名になりますか？

各スキーマキーはPascalCaseに再構成されるため、user-profileはUserProfileになります。同じ名前になるキーが2つある場合、後のキーに番号が追加されます。

### null許容フィールドはサポートされていますか？

はい。OpenAPI 3.0のnullable: trueとSwagger 2.0のx-nullable: trueは| nullを追加し、OpenAPI 3.1の["string", "null"]のような型配列はstring | nullになります。

### ツールで解決できない参照はどうなりますか？

ドキュメント外、またはcomponents.schemasやdefinitions以外の場所にあるスキーマ以外を指す$refはunknownになり、出力の先頭にコメントとして記載されます。

### YAMLはサポートされていますか？

はい。ドキュメントをYAMLまたはJSON形式で貼り付けてください。YAMLのアンカーとエイリアスは変換前に展開されます。

### 最初にドキュメントを確認するにはどうすればよいですか？

OpenAPI Validatorを使うと、構造上の問題や壊れた参照を確認できます。このコンバーターはスキーマを読み取るだけで、ほかのエラーは報告しません。

ここに広告を掲載しませんか？

[メールでお問い合わせ](mailto:hi@dennn.is?subject=OneClick%20Pro%E3%81%A7%E3%81%AE%E5%BA%83%E5%91%8A%E6%8E%B2%E8%BC%89)

[広告 433 個のツールを1つのMCPサーバーでAIエージェントに提供します。](https://multitaskai.com/ja/?ref=oneclickpro)
