Roblox は、すべての Roblox Cloud API を含む OpenAPI 3.0.4 ドキュメント（以前は Swagger ファイルとして知られていました）を公開しています。このファイルは、オープンソースの creator-docs リポジトリにある openapi.json に見つけることができます。
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 エンジンとのエンドポイントの使用性を示すオブジェクト。 |