Get OpenAPI 2.0 JSON from Extend Service Extension app without deploying

Last updated on November 14, 2025

The recommended way to get OpenAPI 2.0 JSON is to deploy the app in AccelByte Gaming Services (AGS) and download the automatically generated file. If you generate OpenAPI 2.0 JSON locally, it will have an incorrect base_path value.

option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
  ...
  base_path: "/service";
  ...
};

To get the correct OpenAPI 2.0 JSON without deploying:

Modify the base_path property in service.proto to match the deployed base path.
Run make proto in the project folder.
The OpenAPI 2.0 JSON file will be saved at gateway/apidocs/service.swagger.json.

注記

Typically, you do not need to modify base_path in service.proto since it will be overwritten with the correct value when your app is deployed in AGS.