JSON → OpenAPI スキーマ生成
JSON のサンプルから、OpenAPI 3.1.0 のスキーマを作ります。出力は最小限のドキュメントで、「info」 のタイトルは 「Generated API」、バージョンは 「1.0.0」、サンプルから推論したスキーマが 「components.schemas.Root」 に入ります。配列の要素の形が違うときは1つのスキーマにまとめ、配列の全要素にあるキーだけを 「required」 に入れます。「2024-01-02T03:04:05Z」 のような日時の文字列は 「format: date-time」 を付け、「null」 は 3.1 の書き方の 「type: "null"」 になります。Swagger Editor などに貼って確認できますが、「paths」 は空なのでエンドポイントは自分で書き足し、「description」・「example」・「enum」 などの制約も手で足します。処理はすべてブラウザの中で行われ、JSON は送信されません。
ガイド使い方・特徴
- 入力欄に JSON を貼り付けて「OpenAPI に変換」をクリックします。
- オブジェクトは properties と required を持つ JSON Schema に展開されます。
- 配列は要素を推論し、複数型が混ざる場合は oneOf でまとめます。
- コピー・リセットボタンで結果を再利用したりやり直したりできます。
サンプル入力例と出力例
Infer schema from a profile object
{"name":"Jane","email":"jane@example.com","verified":true}{
"type": "object",
"properties": {
"name": {"type": "string"},
"email": {"type": "string", "format": "email"},
"verified": {"type": "boolean"}
},
"required": ["name", "email", "verified"]
}FAQよくある質問
どんな OpenAPI のドキュメントが出力されますか?
OpenAPI 3.1.0 の最小限のドキュメントです。`info` のタイトルは `Generated API`、バージョンは `1.0.0`、`paths` は空で、サンプルから推論したスキーマが `components.schemas.Root` に入ります。Swagger Editor などで使えますか?
使えます。出力を貼り付けると、`Root` スキーマを確認できます。`paths` は空なので、エンドポイントは、自分で書き足してください。配列の要素の形が違うときは、どうなりますか?
要素を1つのスキーマにまとめます。配列の全要素にあるキーだけが `required` に入り、一部にしかないキーは入りません。種類の違う値が混じるときだけ `oneOf` になります。日時の文字列は、どう扱われますか?
`2024-01-02T03:04:05Z` のような ISO 8601 の日時は、`type: string` に `format: date-time` を付けます。日付だけの `2024-01-02` は、ただの `string` です。`null` や空の配列は、どうなりますか?
`null` は `type: "null"` になります(3.1 の書き方)。空の配列は、要素の形が分からないので、`items: {}` になります。入力した JSON は送信されますか?
送信されません。変換は、すべてブラウザの中で行います。
使いどころ主な活用シーン
API 設計の下書きを作る
サンプルのレスポンスから、スキーマの骨組みを作り、そこへ説明や制約を足して、設計書にできます。既存 API のレスポンスから、スキーマを起こす
実際のレスポンスを貼って、ドキュメントのない API のスキーマを、すばやく書き起こせます。モックサーバーや、コード生成の入力にする
出力した OpenAPI を、モックサーバーや、クライアント生成のツールに渡す、出発点にできます。レビューで、データの形を共有する
JSON のサンプルだけでは伝わりにくい、キーの型や、必須かどうかを、スキーマとして見せられます。
注意点注意事項・制限
`paths` は空です
エンドポイント(パス・メソッド・リクエスト・レスポンス)は含まれません。出力されるのは、`components.schemas` のスキーマです。サンプル1つからの推論です
`description`・`example`・`enum`・文字数や範囲の制約は入りません。仕様に合わせて、手で足してください。OpenAPI 3.1 の書き方です
`null` は `type: "null"` の `oneOf` になり、`nullable: true` は使いません。3.0 までを前提とするツールでは、書き換えが必要です。必須かどうかは、サンプルしだいです
配列の全要素にあるキーは `required` に入ります。サンプルに偶然、全部あるだけのキーも、必須になるので、実際の仕様と合わせて確認してください。
概要このツールについて
JSONからOpenAPI Schema自動生成ツール
外部APIからのレスポンスJSONや、設計段階のサンプルJSONを貼り付けるだけで、OpenAPI (Swagger) 3.x に準拠した components.schemas のYAML/JSON定義を自動で推論・生成します。
REST APIの開発やドキュメント作成において、巨大なJSONデータの構造を手動でプロパティマッピングし、型(Type)を定義する作業は非常に退屈でミスの起きやすい工程です。本ツールはこのリバースエンジニアリング(推論)を自動化し、仕様書作成を加速させます。
API仕様書作成で役立つポイント
OpenAPIのスキーマは、フロントエンド、バックエンド、QA、外部連携先が同じレスポンス構造を確認するための共通言語になります。サンプルJSONから初期スキーマを生成しておくと、プロパティ名、型、配列構造、ネストされたオブジェクトを手早く整理できます。
手作業で作った仕様書では、実際のAPIレスポンスとドキュメントが少しずつずれることがあります。実レスポンスを貼り付けてスキーマ化し、既存のOpenAPI定義と比較することで、追加された項目や型の変更をレビューしやすくなります。
生成後に確認したいこと
JSONのサンプルだけからは、必須項目、nullable、列挙値、文字列のフォーマット、数値の範囲までは完全には判断できません。生成結果を出発点として、required、description、example、format などを追記すると、読み手にとって使いやすいAPI仕様になります。機密情報を含むレスポンスを扱う場合は、値をマスクしてから入力してください。
おすすめリソース
このセクションにはアフィリエイトリンクが含まれる場合があります。リンク経由で購入すると、追加費用なしでDevToolKits.appが紹介料を受け取ることがあります。
このツールの関連記事
JSONからOpenAPIスキーマを生成する方法|Swagger対応
JSONサンプルからOpenAPI 3.1のcomponents schemaを生成する仕組みを解説。型推論のルール、配列内の型混在をoneOfで表現する方法、日付文字列の自動検知、生成後に確認すべき項目まで整理します。
JSON整形・検証の基本:APIレスポンスを読みやすく安全に確認する方法
APIレスポンスやログに含まれるJSONを整形し、構文エラーを見つけ、値の型を確認して、型生成やスキーマ化へつなげる実務的な確認手順を解説します。DevToolKitsのJSONツールを使った進め方も紹介します。
JSONエコシステム入門:整形・型生成・バリデーション・API定義を実例でつなぐ
JSONを起点にTypeScript型、Zodによる実行時バリデーション、OpenAPI定義へと展開する一連の流れを、実際のコード例でつなげて解説。型安全なAPI開発の全体像がわかります。
JSON SchemaとZodを相互変換する仕組み|requiredと.optional()の対応
JSON SchemaからZodスキーマを生成し、Zodのコードから逆にJSON Schemaを書き出す双方向変換ツールの実装を解説。requiredと.optional()で既定値が逆転している問題、formatや制約の対応表、コードを実行せずに解析する方法まで整理します。
このツールの実装解説
運営者のZenn記事 ↗作る過程で踏んだバグや設計の判断を、Zennに書いています。
