ForHosting KIT · データ変換・整形

JSONをスキーマで検証

Q: 最初の問題で検証は停止しますか？

停止しません。 各違反についてドキュメントパス、スキーマパス、キーワード、説明を報告します。

記録が決められた規則を満たしているかが分かります。例では37歳のAdaとmath、codeのタグがすべての規則を満たすため、問題の一覧は空で返ります。違反があれば、すべての問題を1回でまとめて示します。ブラウザで無料で使えます。

無料
ブラウザで動作
登録不要
データは端末の外に出ません

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

識別子の欠落、想定外のプロパティ、短すぎる文字列、許容範囲外の数値は、解析後のインポートを停止させる原因になります。

書き方だけでなく取り決めを確認

結果には真偽値の<code>valid</code>と<code>violations</code>配列が含まれます。空の配列は、評価したすべての制約を満たしたことを示します。失敗時も最初の問題で停止せず、検出した問題をすべて保持します。

型、必須および依存プロパティ、追加プロパティ、配列要素、文字列長、パターン、数値範囲、定数、列挙、ローカル参照、スキーマ合成などを扱えます。

違反パスから問題箇所を正確に読み取れます

空文字列はルート、<code>/customer/email</code>はcustomer内のemail、<code>/lines/2/quantity</code>は3番目の要素内のquantityを示します。Pointerのエスケープにより、スラッシュやチルダを含むプロパティ名も一意に識別できます。

画面やログには説明文を、プログラム処理にはパスとキーワードをご利用ください。フォームでは該当コントロールに問題を関連付け、パイプラインでは頻出エラーを分類できます。走査順は決定的なため、同じドキュメントとスキーマからは常に同じ結果が得られます。

よくある質問

検証に成功すると何が返されますか？

validがtrueとなり、空のviolations配列が返されます。

最初の問題で検証は停止しますか？

停止しません。各違反についてドキュメントパス、スキーマパス、キーワード、説明を報告します。

問題ごとに示される場所はどう読みますか？

空の場所は文書全体を指します。/customer/emailはcustomerの中のemailを、/lines/2/quantityはlinesの3番目の項目の中のquantityを指します。位置は0から数えるためです。

スキーマではどんな規則を決められますか？

値の種類、必須の項目やほかの項目に依存する項目、想定外の項目を許すかどうか、文字の長さや形、数値の範囲、固定の値や許可する値の一覧、一覧の各要素の規則、複数の規則の組み合わせなどを決められます。

正しく読めるデータが確認で不合格になるのはなぜですか？

読み取りで確かめられるのは、かっこや引用符、カンマが正しいかどうかだけだからです。注文には番号が必要、数量は正の数、知らない項目は拒否するといった期待は、スキーマに書かれて初めて確認できます。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/data/json-schema-validate

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/data/json-schema-validate \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"document":{"name":"Ada","age":37},"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}}'

const res = await fetch("https://api.kit.forhosting.com/data/json-schema-validate", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "document": {
      "name": "Ada",
      "age": 37
    },
    "schema": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        }
      }
    }
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/data/json-schema-validate",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "document": {
        "name": "Ada",
        "age": 37
    },
    "schema": {
        "type": "object",
        "required": [
            "name"
        ],
        "properties": {
            "name": {
                "type": "string"
            }
        }
    }
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/data/json-schema-validate", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"document":{"name":"Ada","age":37},"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"document":{"name":"Ada","age":37},"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/data/json-schema-validate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "document": {
    "name": "Ada",
    "age": 37
  },
  "schema": {
    "type": "object",
    "required": [
      "name"
    ],
    "properties": {
      "name": {
        "type": "string"
      }
    }
  }
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "data.json_schema_validate",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

制限

max_mb 25

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

技術的な注記

JSONは構文として完全に正しくても、受け取るシステムの要件には合わないことがあります。このバリデーターはJSONドキュメントをJSON Schemaと比較し、検出したすべての違反を1回の応答で返します。各問題にはドキュメントのパス、スキーマのパス、キーワード、分かりやすい説明が含まれるため、修正すべきフィールドをすぐに特定できます。

JSONの構文だけでなく契約を検証します

JSONパーサーが確認できるのは、波括弧、引用符、コンマ、値が正しいJSONを構成しているかどうかだけです。注文番号が必須であること、数量が正であること、未知のフィールドを拒否すべきことまでは判断できません。JSON Schemaは、こうした要件を機械可読な契約として表現します。解析済みドキュメントを<code>document</code>に、契約を<code>schema</code>に指定してください。

違反パスから問題箇所を正確に読み取れます

各違反の<code>path</code>はJSON Pointer形式です。<code>schema_path</code>は問題を検出した規則を指し、<code>keyword</code>は<code>required</code>、<code>type</code>、<code>minimum</code>などの安定した分類を示します。

不正なスキーマと無効なデータを区別します

無効なドキュメントは通常の検証結果です。要求は成功し、<code>valid</code>がfalseになり、すべての違反が説明されます。一方、不正なスキーマでは信頼できる検証を実行できません。実装は純粋でネットワークへ接続しないため、リモート参照は取得しません。キーワードの形式が誤っている、型が未知である、正規表現をコンパイルできない、数値制限が不合理である、ローカル参照を解決できない場合、この機能は<code>invalid_input</code>を返します。これにより、壊れた契約を不良データと取り違えません。<code>#/</code>で始まるローカルJSON Pointer参照をご利用ください。API境界、データ取り込み前、構造化出力、ビルド工程での検証に適しています。API要求は$0.002からで、同じロジックをブラウザでも実行できます。

連携の活用例

不正なAPIペイロードの拒否

要求本文を共通契約と照合し、クライアントが修正すべき各フィールドの正確なパスを返します。

データ取り込みの保護

読み込み前に取引先レコードを検証し、欠落フィールドや想定外の構造が後続処理へ進むのを防ぎます。

生成されたJSONの確認

別のシステムが処理する前に、構造化出力の型、範囲、必須プロパティを確認します。

技術的な質問

スキーマ自体が不正な場合はどうなりますか？

不正な契約では信頼できる検証ができないため、invalid_inputエラーになります。

リモートのスキーマ参照に対応していますか？

対応していません。ネットワークを使用せず、指定したスキーマ内のローカルJSON Pointer参照に対応します。

API検証の料金はいくらですか？

各要求は$0.002からです。ブラウザ実行でも対話的な確認に同じ純粋なロジックを使用します。

KITの完全なドキュメントを見る →

JSONをスキーマで検証

無料で実行

書き方だけでなく取り決めを確認

違反パスから問題箇所を正確に読み取れます

よくある質問

関連ツール

開発者向け — APIアクセス

エンドポイント

お使いのスタックから呼び出す

リクエスト例

レスポンス例

料金

制限

エラー

技術的な注記

JSONの構文だけでなく契約を検証します

違反パスから問題箇所を正確に読み取れます

不正なスキーマと無効なデータを区別します

連携の活用例

不正なAPIペイロードの拒否

データ取り込みの保護

生成されたJSONの確認

技術的な質問

ありがとう