Common API Routes

Each API in CPX has three common routes these routes help determine up/down status, the overall health and status of the backend services, as well as the ability to present the API swagger doc in JSON format.

About (/)

  • The about route gives the name and version of the API. You can reach the about using the base URL of the API, i.e. payment/v1/payment.

Health (/health)

  • The health route shows the response time of all of our backend services. You can reach the health route at /health.

Swagger (/swagger)

  • The swagger route returns the swagger file for the api in JSON format. You can reach the swagger route at /swagger