Roblox는 모든 Roblox Cloud API가 포함된 OpenAPI 3.0.4 문서 (이전에는 Swagger 파일로 알려짐)를 게시합니다. 이 파일 openapi.json은 오픈 소스 creator-docs 리포지토리에서 찾을 수 있습니다.
OpenAPI 문서를 Swagger Editor 및 Postman과 같은 도구와 함께 사용하여 호출을 테스트하고 개발을 간소화할 수 있습니다. OpenAPI Generator와 같은 도구는 선호하는 프로그래밍 언어를 위한 클라이언트 라이브러리도 생성할 수 있습니다.
벤더 확장
Roblox는 OpenAPI 사양을 확장하기 위해 사양 확장을 사용합니다. 이러한 확장은 사양이 기본적으로 포착하지 않는 정보를 나타냅니다. 확장은 OpenAPI 사양에서 허용되는 파일의 여러 위치에 나타날 수 있습니다.
이러한 사양 확장의 대부분은 실험적입니다. 사용되는 확장은 공식 OpenAPI 사양에서 발견된 필드를 우선하여 사전 통지 없이 변경될 수 있습니다.
| 확장 | 위치 | 설명 |
|---|---|---|
| x-roblox-extensions-version | OpenAPI 객체 | 여기에서 지정된 확장과 기타 공통 구조의 버전을 나타내는 의미론적 버전 문자열입니다. |
| x-roblox-stability | 작업 객체 | 작업의 안정성 수준을 나타내는 문자열입니다. |
| x-roblox-deprecated | 작업 객체 | 엔드포인트의 사용 중단 상태와 관련된 추가 정보를 제공하는 객체입니다. |
| x-roblox-alternatives | 작업 객체 | 엔드포인트의 대안과 관련된 추가 정보를 제공하는 객체입니다. |
| x-roblox-rate-limits | 작업 객체 | 엔드포인트에 대한 속도 제한 정보를 제공하는 객체입니다. |
| x-roblox-scopes | 작업 객체 | 엔드포인트와 관련된 필수, 조건부 및 선택적 범위 목록을 제공하는 객체입니다. |
| x-roblox-engine-usability | 작업 객체 | Roblox 엔진과의 엔드포인트의 사용성을 나타내는 객체입니다. |