シンプルなオブジェクトからJSON Schemaを生成する

シンプルなオブジェクトのスキーマ生成

フラットなJSONオブジェクトをジェネレーターに貼り付けると、各キーと値のペアを検査し、properties ブロックを持つ type: "object" スキーマを生成します。

内部処理の仕組み

以下のような入力の場合:

{
  "name": "Alice",
  "age": 30,
  "active": true
}

ジェネレーターは次のスキーマを生成します:

{
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "age": { "type": "integer" },
    "active": { "type": "boolean" }
  },
  "required": ["name", "age", "active"]
}

主なポイント

• 型推論: 文字列は "string"、整数は "integer"、小数は "number"、真偽値は "boolean" にマッピングされます。
• required 配列: デフォルトでは、サンプルデータに存在するすべてのキーが required としてマークされます。後から調整可能です。
• 追加の制約なし: 基本的な生成パスでは minLength、minimum、pattern などは追加されません。

より良いスキーマのためのヒント

1. すべてのオプショナルフィールドを含む代表的なサンプルを提供しましょう。
2. 生成後、required 配列を確認し、オプショナルにすべきキーを削除しましょう。
3. ドキュメント目的で各プロパティに description アノテーションを追加しましょう。

シンプルなオブジェクトスキーマは、すべてのJSON Schemaの基礎です。この基本的な生成ステップを習得することが、ネストされたオブジェクト、配列、合成キーワードに取り組む前に不可欠です。