JSON から TypeScript

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

API レスポンスを手入力するのは、特定の方法で面倒でエラーが発生しやすいです。返されたものではなく、エンドポイントが返したものを *think* と入力します。気づかなかったフィールドが省略され、null である整数が `number` と入力されることがあり、エディタではなく本番環境の実行時にミスが表面化します。実際のペイロードから直接型を生成すると、コンパイルするシェイプがサーバーが送信したシェイプになるため、そのギャップは閉じられます。

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

JSON から TypeScript への変換で得られるものを簡単に確認するには、組み込みのサンプルです。 「Load Sample」を押してから、「Generate」を押します。 「Notes」から「TypeScript」へのインターフェイスを 3 つ取得します。「Root」、「Owner」、「Release」の 3 つを取得します。 2 番目のリリースには `notes` キーがないため、マージされた `Release` インターフェイスは `notes?: string` を読み取り、 `retiredAt` は唯一のレコードで null であるため、「retiredAt?: null`」になります。これが正直な結果です。1 つの null は実際のタイプの証拠を与えないためです。実際のエンドポイントに対して JSON を TypeScript に変換するには、推論を比較できるようにいくつかのレコードを貼り付けます。

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