开放API描述

*此内容使用人工智能（Beta）翻译，可能包含错误。若要查看英文页面，请点按 此处。

在 打开云 v2 和 打开云 v1 部分的参考页面是从 OpenAPI 描述 JSON 文件渲染的。这些文件使用 版本 3.0.4 的 OpenAPI 规格。

这些文件是开源的，可以使用像 Swagger 编辑器 和 Postman 这样的工具来测试 API 调用并帮助简化开发。

这些 OpenAPI 描述仍在活动开发中，可能存在问题。资源 部分 下的页面是官方参考。

开放 API 描述文件

开放 API 描述文件可以在 创建者文档 存储库中的以下位置找到：

# 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-4 很高的兼容性，是 API 改进提案之一。
x-oneOf示范对象对象。每个字段包含在 schema 中的属性列表。只有一个属性应该存在。
x-resource示范对象Boolean。是否 schema 是资源。
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操作对象对象。操作的限速限制。