JSON から TypeScript

JSON から TypeScript へのコンバータは、サンプル JSON 値 (API レスポンス、構成ファイル、データベース レコード) を読み取り、それを記述する TypeScript インターフェイスを書き込みます。ネストされたオブジェクトは独自の名前付きインターフェイスになり、オブジェクトの配列は広大な結合ではなく単一の要素インターフェイスにマージされ、一部のレコードからヌルまたは欠落しているキーはオプションとしてマークされます。すでに持っているデータを貼り付けます。手書きで書くタイプを取得します。

手で API レスポンスを入力するのは面倒で、特定の方法でエラーが発生しやすい: エンドポイントが実際に返したものではなく、* 思う* と思う* ものを入力します。 気付かなかったフィールドは省略されます。整数は null である場合があり、「number」と入力され、エディタではなく、実稼働時にエラーが発生します。 実際のペイロードから直接型を生成すると、そのギャップが解消されます。これは、コンパイルしたシェイプがサーバーが実際に送信した形状であるためです。

すべてブラウザで実行されます。推論エンジンは依存関係のない TypeScript であり、リモート サービスのラッパーではないため、アクセス トークン、顧客レコード、内部 ID を日常的に保持するペイロードはページから決して離れることはありません。インターフェイスまたは型エイリアスを選択し、`export` キーワードと `readonly` モディファイアを切り替えて、インデントの幅を選択し、出力をコピーするか、.ts ファイルをダウンロードします。

生成されたインターフェイスは、呼び出している API ではなく、提供したサンプルを記述します、そしてその区別はリスク全体です サンプルのすべてのオブジェクトにたまたま存在するフィールドは、サーバーが時々省略しても必須とマークされ、サンプル内の null であるフィールドは、常に null であるフィールドと区別できません 空の配列が最も明確なケースです: 要素のない配列は、その中に含まれるものについての情報を与えません。 配列のマージは、リスト内のすべてのオブジェクトを 1 つのインターフェイスに結合し、一部のエントリに欠けているキーをオプションとしてマークすることで、ここで役立ちます。そのため、より大きく多様なサンプルは、より正直なタイプを生成します。 API がスキーマまたは OpenAPI ドキュメントを持っている場合、代わりにそこから生成し、文書化されていない応答を探索するために使用します。