View the API document

Each service in KAIZEN has built-in API documentation that lists all available endpoints, their request parameters, and response formats. This documentation is generated automatically and is always up to date with the service's current implementation.

Open the API document

note

In KAIZEN 5.3.0, an API /api/v1/systemConfigs/queryConfigValueWithExpire/{configKey} is added. You can view its API documentation when you select the common service.

Access from App Designer

To view the API document for a service:

1. In App Designer, on the left menu bar, click Services. Find the service you want to inspect, e.g., workflow.

2. Click API Document on the right side of the service row.

   

   The API document for that service opens.

Access from Service Designer

You can also view the API document in the Service Designer:

1. On the project toolbar, click click to open the Service Designer.

2. Select the service and click API Document to view it.

   

API documentation overview

The API documentation page displays the service name, version, and all available API groups and endpoints.

The page shows the following information:

• Service name and version: displayed at the top of the page, along with the OpenAPI Specification (OAS) version and the API base path.
• Controller groups: endpoints are grouped by controller. Each group can be expanded to view the individual endpoints it contains.
• Endpoints: each endpoint shows the HTTP method (e.g., GET, POST), the path, and a short description of the operation.

Last updated on 21 Sep 2026