2026-05-20 · 読了目安 1 分
API 型向け JSON から TypeScript
サンプルレスポンスを interface に変換し、コードレビューで名前を洗練。
TypeScriptJSONAPI
重要ポイント
- nullable フィールドを含む実 API サンプルを使う — ハッピーパスのみの JSON は optional を隠す。
- 共有パッケージ公開前に生成 interface をドメイン言語にリネーム。
推奨ワークフロー
ペイロードを整形し JSON を検証し、ApiUser のようなルート名で interface を生成。
同一ペイロードでツールを連鎖するときは ?prefill= 付きで JSON Formatter に移動。
よくある質問
混在配列の union を推論しますか？
はい — 配列要素が異なる場合 union 要素型を出力。
生成型をコミットすべき？
レビュー後にコミット; API 契約変更時に再生成。