Working with the /apis endpoint

In the base configuration, Guidewire provides a special Swagger schema that the REST framework uses to document the set of APIs published on that server. By default, the REST API schema is available as a GET operation to the /apis endpoint. For example, if running the application server locally, the URL to access the API schema is the following:
  • localhost:8180/pc/rest/apis

The /apis endpoint is itself a standard Swagger API. Accessing the /apis endpoint provides a full list of the available REST APIs along with additional useful information.

The /apis schema definition

Guidewire defines the /apis endpoint in schema file api_list_-1.0.json located in the Project window in Guidewire Studio in the following location:
  • Integration > schemas > gw > pl > framework

In the base configuration, Guidewire lists the api_list-1.0 schema in file published-apis.yaml, which makes the schema file accessible by default.

In file published-apis.yaml, you can do the following:
  • Make the /apis endpoint inaccessible by removing the endpoint from the file.
  • Publish the /apis endpoint to certain environments only by setting environment variables for the endpoint