JSON to OpenAPI コンバーター
JSONレスポンスからOpenAPI 3.0仕様を生成します。
このツールは気に入りましたか？portfolios.toolsを永遠に無料に保つのにご協力ください。
仕組み
テキストエリアにJSON APIレスポンスを貼り付け、エンドポイントパスとHTTPメソッドを設定します。ツールはSwaggerまたはRedocドキュメント用に、サンプルデータからOpenAPI 3.0.3スキーマを推論します。スキーマカバレッジ最大化のため、全フィールドが埋まった代表的な成功ペイロードを使ってください。ネストしたquoteオブジェクト、holdings配列、オプションフィールドを含む金融APIレスポンスは、下流コンシューマー向けに文書化するならサンプルに含めてください。空配列サンプルは要素を1つ以上含むまで汎用配列スキーマのみになります。整形JSONとminify JSONの両方が正しく解析されます。 Financial API responses で nested quote objects と 保有 arrays should show all fields in sample JSON for complete スキーマ. Include error response samples in separate paste 時 documenting production API surface area completely. Include nullable fields in sample JSON 時 API リターンs null for optional finance quote keys.
生成されたinfoブロック、pathsセクション、レスポンススキーマ、スキーマ参照付きcomponentsを確認します。YAMLをSwagger EditorまたはAPIリポジトリdocsフォルダにコピーしてください。本番でフィールドが任意の場合、サンプルJSONに含めるか、エクスポート後にnullableフラグを手動追加してください。CIでopenapi linter検証を実行し、リリース間でバックエンドレスポンス形状が変わってもdocs未更新のスキーマドリフトを検出してください。ダウンロードボタンはdocsリポジトリへ直接コミットできるYAMLを保存します。 Run openapi linter in CI 後 export: backend response drift breaks clients 時 optional fields disappear silently. Components section deduplicates nested objects shared across multiple endpoints in large APIs. 貼り付け：nested quote response from Yahoo proxy or 証券会社 API to document finance chart endpoints.
linter in CI 後 export: backend response drift breaks clients 時 optional fields disappear silently. Components section deduplicates nested objects shared across multiple endpoints in large APIs. 貼り付け：nested quote response from Yahoo proxy or 証券会社 API to document finance chart endpoints.
JSON to OpenAPI コンバーター. 出力はOpenAPI 3.
手順
- JSONレスポンスを貼り付け、エンドポイントパスとメソッドを設定
- 生成されたOpenAPI YAML出力を確認
- 仕様をコピーまたはダウンロードしてドキュメントに使用
計算例
テキストエリアにJSON APIレスポンスを貼り付け、エンドポイントパスとHTTPメソッドを設定します。ツールはSwaggerまたはRedocドキュメント用に、サンプルデータからOpenAPI 3.
JSON to OpenAPI コンバーター: 生成されたinfoブロック、pathsセクション、レスポンススキーマ、スキーマ参照付きcomponentsを確認します。YAMLをSwagger EditorまたはAPIリポジトリdocsフォルダにコピーしてください。本番でフィールドが任意の場合、サンプルJSONに含めるか、エクスポート後にnullableフラグを手動追加してください。CIでopenapi linter検証を実行し、リリース間でバックエンドレスポンス形状が変わってもdocs未更新のスキーマドリフトを検出してください。ダウンロードボタンはdocsリポジトリへ直接コミットできるYAMLを保存します。 Run openapi linter in CI 後 export: backend response drift breaks clients 時 optional fields disappear silently.
この計算機を使うタイミング
この計算機を使うタイミング: JSONレスポンスからOpenAPI 3.0仕様を生成します。
JSON to OpenAPI コンバーター. portfolios.tools
よくある間違い
よくある間違い: テキストエリアにJSON APIレスポンスを貼り付け、エンドポイントパスとHTTPメソッドを設定します。ツールはSwaggerまたはRedocドキュメント用に、サンプルデータからOpenAPI 3.
JSON to OpenAPI コンバーター. 生成されたinfoブロック、pathsセクション、レスポンススキーマ、スキーマ参照付きcomponentsを確認します。YAMLをSwagger EditorまたはAPIリポジトリdocsフォルダにコピーしてください。本番でフィールドが任意の場合、サンプルJSONに含めるか、エクスポート後にnullableフラグを手動追加してください。CIでopenapi linter検証を実行し、リリース間でバックエンドレスポンス形状が変わってもdocs未更新のスキーマドリフトを検出してください。ダウンロードボタンはdocsリポジトリへ直接コミットできるYAMLを保存します。 Run openapi linter in CI 後 export: backend response drift breaks clients 時 optional fields disappear silently.
計算式
型推論：typeofによる整数検出。スキーマビルダーはJSONオブジェクトキーを再帰的に走査します。YAMLエミッターはOpenAPI 3.0.3構造（info、paths、components、$ref）をフォーマットします。
出力はOpenAPI 3.0.3 YAML文字列です。Swagger EditorまたはAPI docsツールに貼り付けてください。本番ドキュメント公開前にopenapi linterで生成specを検証してください。request bodyスキーマ、security schemes、webhook callbacksはエクスポート完了後の手動作成が必要です。 Nullable inference requires null in sample JSON: absent keys are treated as required in output スキーマ. Example driven スキーマ marks all sampled fields required: add nullable true manually for optional API fields. OpenAPI version 3.0.3 chosen for broad tooling support across Swagger Redoc と gateway validators. Validate output YAML で openapi linter in CI 前 publishing to production docs.
制限と前提
出力はOpenAPI 3.0.3 YAML文字列です。Swagger EditorまたはAPI docsツールに貼り付けてください。本番ドキュメント公開前にopenapi linterで生成specを検証してください。request bodyスキーマ、security schemes、webhook callbacksはエクスポート完了後の手動作成が必要です。 Nullable inference requires null in sample JSON: absent keys are treated as required in output スキーマ. Example driven スキーマ marks all sampled fields required: add nullable true manually for optional API fields. OpenAPI version 3.0.3 chosen for broad tooling support across Swagger Redoc と gateway validators. Validate output YAML で openapi linter in CI 前 publishing to production docs. JSON to OpenAPI コンバーター.
用語集
- JSONスキーマはどのように推論されますか？
- ツールはJSONオブジェクトまたは配列を解析し、各フィールドの型を推論し、path、method、レスポンススキーマ、コンポーネント参照付きOpenAPI 3.
- どのような型が検出されますか？
- 値が整数ならinteger。浮動小数点価格はnumber型として解析されます。objectフィールドはpropertiesとrequired配列を持つネストスキーマになります。先頭要素がobjectの配列はitemスキーマを再帰生成します。サンプルJSONにないnullableフィールドは例を追加するまで現れません。string enumは自動推論されません。APIが注文ステータスコードなど固定語彙を使う場合、エクスポート後に許可値を手動で文書化してください。 Array of objects generates item スキーマ で required fields inferred from first element shape.
- Assumption
- APIレスポンスJSONを貼り付け、エンドポイントパスとHTTPメソッドを入力します。生成YAMLはSwagger UI、Redoc、Postmanにインポートして対話型docsにできます。import後、request body、認証、エラーレスポンスは手動追加が必要です。このツールは例からレスポンス形状のみ文書化します。レスポンスフィールド変更時のdiff reviewのため、生成YAMLをAPIリポジトリ横のgitで版管理してください。openapi generatorなどのクライアントSDKジェネレーターは、エクスポートYAMLから言語別型付きbindingを生成します。 Authentication と error responses are manual post steps: this tool documents success body shape from one example only.
代替手段との比較
外部API specと並べて内部ツールを文書化する際は、portfolios.
portfolios.tools 代替手段との比較 JSON to OpenAPI コンバーター.
よくある質問
JSONスキーマはどのように推論されますか？
ツールはJSONオブジェクトまたは配列を解析し、各フィールドの型を推論し、path、method、レスポンススキーマ、コンポーネント参照付きOpenAPI 3.0.3 YAMLを生成します。型推論は各キーを走査し、サンプル構造からネストオブジェクトのrequired配列を自動構築します。プリミティブ配列は型のみのitemsになり、オブジェクト配列は完全なitemスキーマを生成します。サンプルが1バリアントのみの場合、union型とoneOf分岐は自動推論されません。サンプル内ネストnull値はパーサー動作によりnullable型を推論する場合があります。 OpenAPI 3.0.3 output imports into Swagger UI Postman と Redoc without modification. Type inference walks nested objects と builds components スキーマs referenced from paths section.
どのような型が検出されますか？
値が整数ならinteger。浮動小数点価格はnumber型として解析されます。objectフィールドはpropertiesとrequired配列を持つネストスキーマになります。先頭要素がobjectの配列はitemスキーマを再帰生成します。サンプルJSONにないnullableフィールドは例を追加するまで現れません。string enumは自動推論されません。APIが注文ステータスコードなど固定語彙を使う場合、エクスポート後に許可値を手動で文書化してください。 Array of objects generates item スキーマ で required fields inferred from first element shape.
生成されたYAMLはどのように使用しますか？
APIレスポンスJSONを貼り付け、エンドポイントパスとHTTPメソッドを入力します。生成YAMLはSwagger UI、Redoc、Postmanにインポートして対話型docsにできます。import後、request body、認証、エラーレスポンスは手動追加が必要です。このツールは例からレスポンス形状のみ文書化します。レスポンスフィールド変更時のdiff reviewのため、生成YAMLをAPIリポジトリ横のgitで版管理してください。openapi generatorなどのクライアントSDKジェネレーターは、エクスポートYAMLから言語別型付きbindingを生成します。 Authentication と error responses are manual post steps: this tool documents success body shape from one example only. Required array in スキーマ lists every key present in sample: add null samples for optional API fields.
どのOpenAPIセクションが生成されますか？
YAMLはinfo、paths、componentsセクションを構造化します。スキーマ参照はcomponents schemasへのref表記を使います。大きなネストレスポンスも、共有オブジェクトがpathごとに重複せずcomponents下に1回だけ置かれるため読みやすいままです。ネストquoteとholdings配列を含むポートフォリオ APIレスポンスは、同一positionオブジェクトが複数エンドポイントに現れるときcomponents再利用の恩恵を受けます。 HTTP method と path fields map to paths object keys in generated YAML structure.
このツールはリクエストスキーマを生成しますか？
これは例駆動スキーマ生成であり、完全なAPI設計ではありません。本番APIは、単一成功レスポンスを超えてページネーション、エラーコード、authスキームの手動追加が必要です。クライアントが検証失敗とサーバーエラーを明示的に扱う必要があるなら、エラーペイロード用の別サンプルファイルを維持してください。contract firstチームは、本番成功例とエラー例を順に貼り付けて完全specを構築することが多いです。webhook callbackスキーマは別JSONサンプルが必要です。このツールは一度に1レスポンスボディのみ処理します。 Version スキーマ in git beside API handlers so frontend types と OpenAPI stay synchronized each release. Pagination query params must be added manually 後 example driven generation completes. Import generated YAML into Postman collection for team shared API documentation without manual retyping.
JSON to OpenAPI コンバーターはスマホで使えますか？
はい。JSON to OpenAPI コンバーターはモダンなモバイルブラウザで動作します。入力の保存は端末内のみです。
JSON to OpenAPI コンバーターのデータはどこに保存されますか？
サーバーには保存されません。計算はブラウザ内で完結します。
JSON to OpenAPI コンバーターを税務や法務判断に使ってよいですか？
いいえ。JSON to OpenAPI コンバーターは学習用の試算です。重要な決定前は専門家に相談してください。
関連ツール
外部API specと並べて内部ツールを文書化する際は、portfolios.toolsのYAML to JSON Converterでポートフォリオ設定を変換してください。生成レスポンススキーマをAPI Mock Generatorと組み合わせ、バックエンドデプロイ前にクライアントSDKをテストできます。 API Mock Generator consumes OpenAPI output to build frontend fixtures without live backend during development. SQL to TypeScript と API Mock Generator complete contract first toolchain ポートフォリオs.toolsで.