Roblox เผยแพร่เอกสาร OpenAPI 3.0.4 (เดิมเรียกว่าไฟล์ Swagger) ที่มี ทั้งหมด ของ Roblox Cloud APIs คุณสามารถค้นหาไฟล์นี้ openapi.json ในที่เก็บ creator-docs ที่เป็นโอเพนซอร์ส
คุณสามารถใช้เอกสาร OpenAPI พร้อมกับเครื่องมือต่างๆ เช่น Swagger Editor และ Postman เพื่อลองเรียกใช้งานและช่วยให้การพัฒนาเป็นไปอย่างราบรื่น เครื่องมือเช่น OpenAPI Generator ยังสามารถสร้างไลบรารีของลูกค้าสำหรับภาษาการเขียนโปรแกรมที่คุณต้องการได้
เอกสารนี้ยังอยู่ระหว่างการพัฒนาที่ใช้งานอยู่และอาจมีปัญหา แจ้งข้อผิดพลาดหากคุณพบข้อมูลที่ไม่ถูกต้อง
ขยายพันธุ์ผู้ขาย
Roblox ใช้ การขยายข้อกำหนด เพื่อขยายข้อกำหนด OpenAPI การขยายเหล่านี้แสดงถึงข้อมูลที่ข้อกำหนดไม่ได้จับตามองโดยค่าเริ่มต้น การขยายอาจปรากฏตลอดทั้งไฟล์ที่อนุญาตโดยข้อกำหนด OpenAPI
ส่วนใหญ่ของการขยายข้อกำหนดเหล่านี้เป็นแบบทดลอง การขยายที่ใช้อาจมีการเปลี่ยนแปลงโดยไม่ต้องแจ้งล่วงหน้าเพื่อสนับสนุนฟิลด์ที่พบในข้อกำหนด OpenAPI อย่างเป็นทางการ
| การขยาย | ตำแหน่ง | คำอธิบาย |
|---|---|---|
| x-roblox-extensions-version | วัตถุ OpenAPI | สตริงเวอร์ชันที่ใช้เวอร์ชันเชิงอรรถศาสตร์ ซึ่งแสดงถึงเวอร์ชันของการขยายที่ระบุไว้ที่นี่และโครงสร้างทั่วไปอื่นๆ |
| x-roblox-stability | วัตถุ Operation | สตริงที่แสดงถึงระดับความเสถียรของการดำเนินการ |
| x-roblox-deprecated | วัตถุ Operation | วัตถุที่ให้ข้อมูลเพิ่มเติมเกี่ยวกับสถานะการถูกยกเลิกของจุดสิ้นสุด |
| x-roblox-alternatives | วัตถุ Operation | วัตถุที่ให้ข้อมูลเพิ่มเติมเกี่ยวกับทางเลือกของจุดสิ้นสุด |
| x-roblox-rate-limits | วัตถุ Operation | วัตถุที่ให้ข้อมูลเกี่ยวกับการจำกัดอัตราสำหรับจุดสิ้นสุด |
| x-roblox-scopes | วัตถุ Operation | วัตถุที่ให้รายการของขอบเขตที่จำเป็น เงื่อนไข และทางเลือกที่เชื่อมโยงกับจุดสิ้นสุด |
| x-roblox-engine-usability | วัตถุ Operation | วัตถุที่บ่งชี้ถึงการใช้งานของจุดสิ้นสุดร่วมกับ Roblox engine |