ForHosting KIT · 開発者向けツール

JSONからスキーマを自動生成

サンプルとなるJSONデータを読み込み、各項目の型や必須かどうか、入れ子構造を判定してJSON Schemaとして書き出すツールです。API設計やデータ検証の準備で、手書きの定義作業を省けます。

● 安定提供中文書あたり$0.003

実行 — $0.003 + $0.0135/文書 API仕様を見る

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

オンラインで実行

アカウントでログインし、当社のサーバー上で実行します。無料ツールはブラウザ内で動作しますが、これは上記の料金がKIT残高から差し引かれます。

何を読み取るか

渡されたJSONデータの各項目について、文字列・数値・真偽値・配列・オブジェクトといった型を判定します。複数件のサンプルを渡すと、値が存在しない場合がある項目を任意項目として扱うなど、より実態に近いスキーマになります。

使い方

APIのレスポンス例やフォームの送信データなど、実際のJSONを貼り付けて実行します。ネストしたオブジェクトや配列にも対応し、生成されたスキーマはJSON Schemaの標準的な形式で返されます。

向いている場面

外部APIのレスポンス構造を社内で共有する資料づくりや、フォーム入力値のサーバー側検証ルールの土台づくりに向いています。手書きで一から定義するより、実データから始めるほうが漏れが少なくなります。

料金

1件の生成につき基本料金$0.003（米ドル）とスキーマ生成料金$0.0135の合計、$0.0165です。同じ構造のデータを何度も手で定義し直す手間と比べて、都度の実行で完結します。

活用例

外部APIレスポンスの構造を文書化

個人開発者の山本翔太は、連携先のAPIから返るJSONのサンプルを読み込ませ、スキーマを社内の仕様書に貼り付けています。

フォーム送信データの検証ルール作成

合同会社みどりデザインでは、問い合わせフォームの送信データからスキーマを生成し、サーバー側の入力チェックの土台にしています。

受託案件の仕様すり合わせ

田中大輔は、クライアントから届いたサンプルJSONをもとにスキーマを生成し、認識のずれがないか実装前にすり合わせています。

よくある質問

送信したJSONデータは保存されますか

スキーマを生成する処理にのみ使用し、処理後にサーバー側で保管され続けることはありません。実データをそのまま使う場合もご利用いただけます。

1回で送れるJSONの分量に上限はありますか

固定の上限は設けていません。分量が極端に大きい場合は、代表的な項目を含む一部のサンプルに絞って実行することをおすすめします。

複数件のサンプルをまとめて渡すとどうなりますか

件によって値の有無が異なる項目を任意項目として扱うなど、より実態に近いスキーマになります。1件だけの場合は、その1件の構造がそのまま反映されます。

生成されたスキーマはJSON Schemaのどのバージョンに準拠しますか

標準的な記法で生成します。特定のバージョン固有の記法が必要な場合は、生成後に該当箇所を調整してください。

料金はどのように計算されますか

1件の生成につき$0.003に$0.0135を加えた$0.0165です。米ドル建てで、月額契約は不要です。

日本語のサポートはありますか

日本語でのサポートは行っておりません。サポートは英語またはスペイン語で、担当者が直接対応します。

開発者向け — APIアクセス

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

エンドポイント

POSThttps://api.kit.forhosting.com/dev/json-schema-gen

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

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

curl -X POST https://api.kit.forhosting.com/dev/json-schema-gen \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d &#39;{"input":"…"}'

const res = await fetch("https://api.kit.forhosting.com/dev/json-schema-gen", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "input": "…"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/dev/json-schema-gen",
    headers={"Authorization": f"Bearer {os.environ[&#39;KIT_KEY']}"},
    json={
    "input": "…"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/json-schema-gen", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => &#39;{"input":"…"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"input":"…"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/json-schema-gen", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "input": "…"
}

レスポンス例

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

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

料金

1リクエストあたり$0.003

文書あたり$0.0135

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

エラー

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

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