JCP: How to enable Swagger OpenAPI

[Michael A. Lowry]

Yesterday I noticed this new section in the Automation Engine documentation page on Using the REST API.

Get Swagger Documentation

You can get the swagger based REST API documentation by sending a request via web browser to display the readable response, see REST API Reference.

Request: The AE REST API Reference documentation can be requested in three different formats:

1. 1. GET http://{host}:{port}/ae/api/v1 or http://{host}:{port}/ae/api/v1/openapi2/index.html

   2. GET http://{host}:{port}/ae/api/v1/openapi2/swagger.json

   3. GET http://{host}:{port}/ae/api/v1/openapi2/swagger.yaml

Example: http://my-jcp-host:8088/ae/api/v1

HTTP 200 Response: The swagger-based API reference in the requested format

The Swagger OpenAPI documentation is not enabled by default. A knowledge base article that explains how to enable the feature.
Swagger documentation not loading, JCP is working

Add the following to your ucsrv.ini under the [REST] section:
docu=1

This option is not documented anywhere in the official AE documentation. (It should probably be documented on the page describing the structure of the ucsrv.ini file.)
Ping @Elina McCafferty

[Michael A. Lowry]

The Try it out feature is disabled in the JCP, somewhat limiting the usefulness of enabling SwaggerUI.

The SwaggerUI documentation explains that the Try it out feature is disabled by default.

[Michael A. Lowry]

I submitted a new idea for this:

Enable SwaggerUI 'Try It Out' feature in JCP

If you like the idea, please vote for it.

[Adrian Fresno Menendez]

Thanks Michael for letting us know about this. The documentation has now been fixed adding the necessary parameter:
Note: Make sure that the docu= parameter in the [REST] section of the INI file of the Automation Engine (see Automation Engine INI file) is set to 1 (enabled). Otherwise, the endpoint to request the AE REST API (Swagger) documentation is disabled.