Accessing the OpenAPI specification

The OpenAPI specification is an industry standard API description format available in YAML and JSON. The OpenAPI specification provides the financial institution with detailed information about FTM services, including the ones that are shown in the following list.

• Available endpoints
• Available operations for each endpoint
• Operation parameters (inputs and outputs for each operation)
• Model structures, which include the ones that are shown in the following list.
  • Data types
  • Descriptions
  • Constraints
  • Examples

Each Liberty server deployment that hosts FTM web services provides URL access to the deployed OpenAPI specification for the available services. When the Liberty service starts, it outputs the available URL for public access. The following URLs can be used to reference the OpenAPI documentation:

/openapi/ui

Graphical representation of the OpenAPI documentation.

/openapi

Text-based representation of the OpenAPI documentation in YAML. It is typically used for RESTful client generation.

If JSON format is preferred, you can access the URL with the ?format=json query parameter.

The following sample shows an example of the console output.

[AUDIT   ] CWWKT0016I: Web application available (default_host): http://{yourhost}:57080/openapi/
[AUDIT   ] CWWKT0016I: Web application available (default_host): http://{yourhost}:57080/openapi/ui/