คำอธิบายของ OpenAPI

*เนื้อหานี้แปลโดยใช้ AI (เวอร์ชัน Beta) และอาจมีข้อผิดพลาด หากต้องการดูหน้านี้เป็นภาษาอังกฤษ ให้คลิกที่นี่

หน้าอ้างอิงในส่วน Open Cloud v2 และ Open Cloud v1 จะถูกแสดงจากไฟล์ JSON ที่เป็น คําอธิบาย OpenAPIไฟล์เหล่านี้ใช้รุ่น 3.0.4 ของข้อกำหนด OpenAPI

ไฟล์เหล่านี้เป็นแหล่งทรัพยากรที่เปิดเผยและสามารถใช้กับเครื่องมือเช่น เครื่องมือตัวแก้ไข Swagger และ Postman เพื่อทดสอบการโทร API และช่วยลดขั้นตอนการพัฒนา

คำอธิบาย OpenAPI เหล่านี้ยังคงอยู่ในการพัฒนาอย่างต่อเนื่องและอาจมีปัญหาหน้าภายใต้ส่วน ทรัพยากร เป็นคำอธิบายอย่างเป็นทางการ

ไฟล์คำอธิบาย OpenAPI

ไฟล์คำอธิบาย OpenAPI มีอยู่ที่ตำแหน่งต่อไปนี้ภายในคลังเก็บ creator-docs :


# 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ส่วนขยายเหล่านี้แทนที่ข้อมูลที่ข้อกำหนดไม่จับโดยปกติส่วนขยายอาจปรากฏตลอดทั้งไฟล์ที่อนุญาตโดยข้อกำหนดของ 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วัตถุปฏิบัติวัตถุขีดจํากัดการบีบอัดสําหรับการดําเนินการ