URL format

The format of the REST URL is a combination of a couple of different segments. The local URL is shorter than the server URL since only one service is available at a time when running locally.

Server

  • Format: https://{BaseUrl}/{Tenant}/BaaSApi/{SuiteContext}/{ServiceName}/{OpenApiName}/{BasePath}/{Path}
  • Example: https://{BaseUrl}/{Tenant}/BaaSApi/baasservices/helloworldjava/helloworld/api/v1/helloworld

Local

  • Format: http://{BaseUrl}/{OpenApiName}/{BasePath}/{Path}
  • Example: http://localhost:7071/helloworld/api/v1/helloworld

Segments

  • SuiteContext: The "context" that is specified under "restHandler -> suite" in the manifest.
  • ServiceName: The name of the service that is specified in "name" in the manifest. The name is automatically converted to lower case. This matches one endpoint in API Gateway.
  • OpenApiName: The name of the OpenAPI file that is automatically converted to lower case. This is specified in the manifest. The name is also added to the generated REST api. This matches one resource in API Gateway.
  • BasePath: The base path. This is specified in the OpenAPI file.
  • Path: The path. This is specified in the OpenAPI file.
Note: If any of these are changed in the manifest, some manual clean up might be needed. See the Code generation section below.