OpenAPI 설명

Open Cloud v2 및 Open Cloud v1 섹션의 참조 페이지는 OpenAPI 설명에서 JSON 파일로 렌더링됩니다.이 파일은 OpenAPI 사양의 버전 3.0.4를 사용합니다.

이 파일은 오픈 소스이며 Swagger 편집기 및 Postman과 같은 도구로 API 호출을 테스트하고 개발을 간소화하는 데 사용할 수 있습니다.

이 OpenAPI 설명은 여전히 활발한 개발 중이며 문제가 있을 수 있습니다.리소스 섹션 아래의 페이지는 공식 참조입니다.

OpenAPI 설명 파일

OpenAPI 설명 파일은 다음 위치에서 크리에이터 문서 리포지토리 내에서 사용할 수 있습니다.


# 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 사양 내의 필드를 우선하여 통지 없이 변경될 수 있습니다.

V1 및 V2 리소스에 대한 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	작업 개체	개체.작업에 대한 제한 속도.

OpenAPI 설명 파일

벤더 확장

이 페이지