Opisy OpenAPI

*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

Strony referencyjne w sekcjach Open Cloud v2 i Open Cloud v1 są renderowane z plików JSON, które są opisami OpenAPI.Te pliki używają wersji 3.0.4 specyfikacji OpenAPI.

Te pliki są open source i można ich używać z narzędziami takimi jak Edytor Swaggera i Postman, aby testować wezwania API i pomóc uprościć rozwój.

Te opisy OpenAPI nadal są w fazie aktywnego rozwoju i mogą zawierać problemy.Strony w sekcji Zasoby są oficjalnym odniesieniem.

Pliki opisu OpenAPI

Pliki opisu OpenAPI są dostępne w następujących lokalizacjach w repozytorium 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

Rozszerzenia sprzedawcy

Roblox wykorzystuje rozszerzenia specyfikacji do rozszerzenia specyfikacji OpenAPI.Te rozszerzenia reprezentują informacje, które specyfikacja nie rejestruje domyślnie.Rozszerzenia mogą pojawić się w całym pliku, jeśli jest to dozwolone przez specyfikację OpenAPI.

Większość tych rozszerzeń specyfikacji jest eksperymentalna.Używane rozszerzenia podlegają zmianie bez powiadomienia na korzyść pól znalezionych w oficjalnej specyfikacji OpenAPI.

Rozszerzenia specyfikacji zasobu V2

RozszerzenieLokalizacjaOpis
x-categoriesObiekt OpenAPILista strun.Wszystkie kategorie zasobów.
x-visibilityObiekt operacjiBoolean.Widoczność operacji.
x-roblox-docsObiekt operacjiObiekt.Kojarzy operację z kategorią i zasobem.
x-long-running-operation-parametersObiekt operacjiObiekt.Odwołuje się do metadanych i odpowiedzi dla długiej odpowiedzi na operację.
x-aep-resourceObiekt schematuObiekt.Rozszerzenie anotujące wpisywaćzasobu.Ma bliską kompatybilność z AEP-4 , jedną z propozycji ulepszeń API .
x-oneOfObiekt schematuObiekt.Każde pole zawiera listę właściwości w schemacie.Tylko jedna z właściwości powinna być obecna.
x-resourceObiekt schematuBoolean.Czy schemat jest zasobem.
x-immutableObiekt schematuBoolean.Czy schemat jest niezmienny.

Rozszerzenia specyfikacji zasobu V1

RozszerzenieLokalizacjaOpis
x-roblox-cloud-api-operationOperator ObiektuBoolean.Czy operacja jest operacją w chmurze otwartej.
x-roblox-cloud-api-operation-nameObiekt operacjiString.Nazwa operacji.
x-roblox-cloud-api-operation-code-samplesObiekt operacjiObiekt.Lista próbek kodu, obiekt z językiem/tytułem i odpowiadającym skryptem.
x-roblox-cloud-api-operation-throttling-limitObiekt operacjiObiekt.Ograniczenia przepustowości dla operacji.