OpenAPI の説明

*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

Open Cloud v2 および Open Cloud v1 セクションの参照ページは、 OpenAPI の説明 から JSON ファイルをレンダリングします。これらのファイルは、オープン API 仕様バージョン 3.0.4 を使用します。

これらのファイルはオープンソースであり、Swagger エディタPostmanなどのツールを使用して、API 呼び出しをテストし、開発をスムーズにするのに役立ちます。

これらの OpenAPI の説明はまだ開発中であり、問題が含まれている可能性があります。 リソース セクションのページは、公式の参照です。

オープン API 説明ファイル

OpenAPI の説明ファイルは、クリエイタードキュメント リポジトリ内の次の場所で利用可能です:


# All V2 Resources
https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/cloud.docs.json
# V1 Assets
https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/assets/v1.json
# V1 Ordered Data Stores
https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/ordered-v1.json
# V1 Standard Data Stores
https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/v1.json
# V1 Messaging
https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/messaging-service/v1.json
# V1 Universes
https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/universes-api/v1.json

ベンダー拡張

Roblox は、仕様拡張 を使用して、OpenAPI 仕様を拡張します。これらの拡張は、仕様がデフォルトでキャプチャしない情報を表します。拡張は、オープン API 仕様によって許可される限り、ファイル全体に表示される可能性があります。

これらの仕様拡張の大部分は実験的です。使用されている拡張は、公式の OpenAPI 仕様内のフィールドを優先して変更することなく変更される可能性があります。

V2 リソース仕様拡張

拡張場所説明
x-categoriesOpenAPI オブジェクト文字列のリスト。すべてのリソースカテゴリ。
x-visibility操作オブジェクトBoolean。操作の可視性。
x-roblox-docs操作オブジェクトオブジェクト。操作をカテゴリとリソースに関連付ける
x-long-running-operation-parameters操作オブジェクトオブジェクト。オペレーションの長時間応答のメタデータとレスポンスを参照します。
x-aep-resourceスキームオブジェクトオブジェクト。リソースタイプをアノテーションする拡張。は AEP-4API 強化提案 の 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操作オブジェクトオブジェクト。オペレーションのスロットリング制限。