Accessing the Process Federation Server REST APIs with Swagger

IBM® Process Federation Server provides a set of REST APIs that can be automatically discovered when the server is running by using the Liberty API Discovery feature.

About this task

The Liberty API Discovery feature dynamically builds a Swagger definition for the REST APIs and offers a URL endpoint to view and interact with those APIs.

To access the REST APIs using Swagger, complete the following steps.

Procedure

  1. Make sure that the feature apiDiscovery-1.0 is installed by running the following command <PFS_HOME>/bin/productInfo featureInfo, and checking that the feature is in the result list.
    1. Optional: If apiDiscovery-1.0 is not listed in the command output, stop the server, and install the feature by running
      <PFS_HOME>/bin/featureManager install apiDiscovery-1.0.
  2. Make sure that the feature is enabled in the server.xml by adding the following definition into the <featureManager> element:
    <feature>apiDiscovery-1.0</feature>
  3. Optional: If you stopped the server, restart it.
  4. Access the Swagger interface for the REST APIs available as a rendered HTML page from a URL with the following format: https://pfsHost.com:https_port_number/ibm/api/explorer
    Note: You must authenticate with a user defined in the Process Federation Server user registry to be granted access and use the REST API endpoints.