Access information about an API endpoint

The Swagger UI provides self-documenting information about each published REST API.

Procedure

  1. Ensure that the PolicyCenter application server is running.
  2. Navigate to some variation of the following URL, using the correct host:port as necessary:
    • http://localhost:8180/pc/resources/swagger-ui/
  3. Click GET / Returns a list of available APIs.
  4. In the pane that opens, click Try it out, then click Execute.
  5. The GET operation returns a list of published APIs in the Response body area.
  6. Copy the docs URL for the API of interest to the clipboard.
  7. Paste the URL string into the box at the top of the Swagger UI screen and click Explore.
    The Swagger UI updates to contain information about that specific API.