OpenAPI パラメータ シリアル化ラボ

API パラメータがネットワーク上でどのように表示されるかを確認する

OpenAPI のパス、クエリ、ヘッダー、Cookie パラメーターがスタイルおよび展開設定に従ってどのようにシリアル化されるかをローカルでプレビューします。

使い方

1. 次の項目から元データを指定します：OpenAPI仕様。
2. 実行する操作：検査仕様書。コピー、ダウンロード、ほかの用途への使用前に結果を確認します。
3. 設定する項目：パス操作。下の説明を参照し、目的に合う選択肢を選んでください。
4. 実行する操作：シリアル化のプレビュー。コピー、ダウンロード、ほかの用途への使用前に結果を確認します。
5. OpenAPI 3.0、3.1、または 3.2 ドキュメントを貼り付けるか選択し、それを検査し、パス操作を選択して、各 JSON パラメーター値を調整します。パス、クエリ文字列、ヘッダー、Cookie をプレビューし、必要な部分をコピーします。

設定の選び方

うまく動かないとき

• コンテンツベースのパラメータ、入れ子になった配列やオブジェクト、未定義のスタイルの組み合わせ、外部参照は推測されません。ヘッダーの引用規則はヘッダーに依存するため、ヘッダー値は URI エンコードなしで表示されます。スキーマは検証されていません。
• いいえ。このツールは、選択した操作のローカル プレビューのみを作成します。サーバーの解決、認証の追加、ネットワーク リクエストの送信は行いません。
• 解析に失敗したら、APIの指摘を確認する前にJSONやYAMLの構文を確認します。必要なローカル参照は同じ文書に含めてください。未解決の外部参照や未対応のスキーマは手作業で確認します。このツールは参照先を取得せず、実サーバーをテストしません。