Open Cloud v2 および Open Cloud v1 セクションの参照ページは、 OpenAPI の説明 から JSON ファイルをレンダリングします。これらのファイルは、オープン API 仕様バージョン 3.0.4 を使用します。
これらのファイルはオープンソースであり、Swagger エディタやPostmanなどのツールを使用して、API 呼び出しをテストし、開発をスムーズにするのに役立ちます。
これらの OpenAPI の説明はまだ開発中であり、問題が含まれている可能性があります。 リソース セクションのページは、公式の参照です。
オープン API 説明ファイル
OpenAPI の説明ファイルは、クリエイタードキュメント リポジトリ内の次の場所で利用可能です:
# All V2 Resourceshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/cloud.docs.json# V1 Assetshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/assets/v1.json# V1 Ordered Data Storeshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/ordered-v1.json# V1 Standard Data Storeshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/v1.json# V1 Messaginghttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/messaging-service/v1.json# V1 Universeshttps://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/universes-api/v1.json
ベンダー拡張
Roblox は、仕様拡張 を使用して、OpenAPI 仕様を拡張します。これらの拡張は、仕様がデフォルトでキャプチャしない情報を表します。拡張は、オープン API 仕様によって許可される限り、ファイル全体に表示される可能性があります。
これらの仕様拡張の大部分は実験的です。使用されている拡張は、公式の OpenAPI 仕様内のフィールドを優先して変更することなく変更される可能性があります。
V2 リソース仕様拡張
拡張 | 場所 | 説明 |
---|---|---|
x-categories | OpenAPI オブジェクト | 文字列のリスト。すべてのリソースカテゴリ。 |
x-visibility | 操作オブジェクト | Boolean。操作の可視性。 |
x-roblox-docs | 操作オブジェクト | オブジェクト。操作をカテゴリとリソースに関連付ける |
x-long-running-operation-parameters | 操作オブジェクト | オブジェクト。オペレーションの長時間応答のメタデータとレスポンスを参照します。 |
x-aep-resource | スキームオブジェクト | オブジェクト。リソースタイプをアノテーションする拡張。は AEP-4 、API 強化提案 の 1 つとの互換性が高い。 |
x-oneOf | スキームオブジェクト | オブジェクト。各フィールドには、スキームのプロパティのリストが含まれています。プロパティの 1 つだけが存在する必要があります。 |
x-resource | スキーマオブジェクト | Boolean。スキームがリソースかどうか。 |
x-immutable | スキームオブジェクト | Boolean。スキームが変更不可能かどうか。 |
V1 リソース仕様拡張
拡張 | ロケーション | 説明 |
---|---|---|
x-roblox-cloud-api-operation | 操作オブジェクト | Boolean。オペレーションがオープンクラウド操作かどうか。 |
x-roblox-cloud-api-operation-name | 操作オブジェクト | 文字列。操作の名前。 |
x-roblox-cloud-api-operation-code-samples | 操作オブジェクト | オブジェクト。コードサンプルのリスト、言語/タイトルと対応するスクリプトのオブジェクト |
x-roblox-cloud-api-operation-throttling-limit | 操作オブジェクト | オブジェクト。オペレーションのスロットリング制限。 |