หน้าอ้างอิงในส่วน Open Cloud v2 และ Open Cloud v1 จะถูกแสดงจากไฟล์ JSON ที่เป็น คําอธิบาย OpenAPIไฟล์เหล่านี้ใช้รุ่น 3.0.4 ของข้อกำหนด OpenAPI
ไฟล์เหล่านี้เป็นแหล่งทรัพยากรที่เปิดเผยและสามารถใช้กับเครื่องมือเช่น เครื่องมือตัวแก้ไข Swagger และ Postman เพื่อทดสอบการโทร API และช่วยลดขั้นตอนการพัฒนา
คำอธิบาย OpenAPI เหล่านี้ยังคงอยู่ในการพัฒนาอย่างต่อเนื่องและอาจมีปัญหาหน้าภายใต้ส่วน ทรัพยากร เป็นคำอธิบายอย่างเป็นทางการ
ไฟล์คำอธิบาย OpenAPI
ไฟล์คำอธิบาย OpenAPI มีอยู่ที่ตำแหน่งต่อไปนี้ภายในคลังเก็บ creator-docs :
# 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ส่วนขยายเหล่านี้แทนที่ข้อมูลที่ข้อกำหนดไม่จับโดยปกติส่วนขยายอาจปรากฏตลอดทั้งไฟล์ที่อนุญาตโดยข้อกำหนดของ OpenAPI
ส่วนใหญ่ของการขยายข้อกำหนดเหล่านี้เป็นการทดลองส่วนขยายที่ใช้อยู่อาจมีการเปลี่ยนแปลงโดยไม่แจ้งให้ทราบล่วงหน้าเพื่อสนับสนุนฟิลด์ที่พบภายในข้อกำหนด OpenAPI อย่างเป็นทางการ
ขยายข้อกำหนดทรัพยากร V2
ขยาย | ตำแหน่ง | คําอธิบาย |
---|---|---|
x-categories | วัตถุ OpenAPI | รายการของสตริงทุกหมวดหมู่ทรัพยากร |
x-visibility | วัตถุการดำเนินการ | Booleanการมองเห็นการดำเนินการ |
x-roblox-docs | วัตถุปฏิบัติ | วัตถุเชื่อมโยงการดำเนินการกับหมวดหมู่และทรัพยากร |
x-long-running-operation-parameters | วัตถุปฏิบัติ | วัตถุอ้างถึงเมตาดาตาและคำตอบสำหรับการตอบสนองที่ยาวนานของการดำเนินการ |
x-aep-resource | วัตถุสเคม่า | วัตถุส่วนขยายที่บอกประเภททรัพยากรมีความสอดคล้องใกล้เคียงกับ AEP-4 หนึ่งใน ข้อเสนอแนะการปรับปรุง API |
x-oneOf | วัตถุสเคม่า | วัตถุแต่ละฟิลด์มีรายการคุณสมบัติในสเคมาในรายการควรมีเพียงหนึ่งในคุณสมบัติเท่านั้น |
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 | วัตถุปฏิบัติ | วัตถุขีดจํากัดการบีบอัดสําหรับการดําเนินการ |