TypeScript to JSON Schemaコンバーターとは?
このツールはTypeScriptインターフェースをJSON Schema形式に変換します。JSON SchemaはJSONデータの注釈と検証のための語彙で、APIドキュメント、フォームバリデーション、設定ファイルの検証に広く使われています。TypeScriptの型を変換することで、バリデーター、APIゲートウェイ、ドキュメントツールで使用できるスキーマが得られます。
使い方
- 入力エリアにTypeScriptインターフェース定義を貼り付けます。
- 「JSON Schemaに変換」をクリックしてスキーマを生成します。
- 出力されたJSON Schemaをプロジェクトで使用するためにコピーします。
サポートされるTypeScript型
このツールは基本的なTypeScript型をサポートしています:string、number、boolean、any、オプショナルプロパティ(?)、配列(type[]またはArray<type>)。またnullとnullとのユニオン型(例:string | null)も認識します。
よくある質問
ネストされたインターフェースに対応していますか?
このツールはフラットなプロパティ型を持つ単一のインターフェースを一度に解析します。ネストされたオブジェクトの場合、別々のインターフェースとして定義してスキーマを手動で組み合わせるか、インターフェース内でインラインオブジェクト型を使用してください。
どのJSON Schemaバージョンが生成されますか?
出力はJSON Schema Draft-07(http://json-schema.org/draft-07/schema#)に従っています。これはバリデーターやツール全体で最も広くサポートされているバージョンです。