JSONスキーマ・型生成ツール
APIレスポンスに正式な仕様を持たせたいとき、手書きのインターフェースの代わりに型が欲しいとき、実際のJSONサンプルを構造化された成果物に変換するツール群です。ペイロードを文書化・検証するJSON Schemaの生成から、TypeScript・Go・Java・Python・Swiftなどへのモデル自動生成まで、モデルを手で書かずに済みます。
型生成系は1件のオブジェクトだけでなく複数の配列サンプルをまとめて見るため、たまに欠けるフィールドを当て推量ではなくoptionalとして検出できます。JSON Schemaモックデータ生成はシード値から再現可能なテストデータを作り、JSONスキーマ差分は破壊的変更を方向まで含めて表示します。すべてブラウザ内でローカルに実行されます。
11個のツール
スキーマ・型生成ツールに関するFAQ
JSONからTypeScriptに複数のサンプルレスポンスを貼り付けてください。1件だけでなく複数の配列サンプルを使うことで、時々欠けるフィールドを当て推量ではなくoptionalとして検出できます。JSONからGo構造体、JSONからJavaなど他言語の型生成でも同じ考え方が使えます。
TypeScriptのインターフェースはコンパイル時にコードベース内で形をチェックするだけです。JSON Schemaは実行時に使える言語非依存の契約で、JSON Schemaバリデーターで実データを検証したり、他サービスと共有したり、JSON Schemaモックデータ生成でテストデータを作ったりできます。
新旧2つのバージョンをJSONスキーマ差分にかけてください。変更は方向まで報告されるので、新たに必須になったフィールドは旧スキーマでデータを生成する側を壊し、逆に必須が外れたフィールドは主に厳密なチェックをする利用側に影響します。差分そのものだけでなく方向を読むことが重要です。