Swagger configuration

The auto-generated Swagger documentation for Spring-based REST API is configured in WorkFusion with regard to Springfox libraries. Enabled from a specific property, it requires a standard login to the WorkFusion platform.

Using the documentation, you can examine all available public API endpoints, read call descriptions, and even execute selected requests by pressing the Try it out! button.

Enable Swagger

Due to security reasons, access to Swagger is disabled by default. To enable access, add the specific property file to tomcat:

${catalina.home}/conf/workfusion.properties

The file should include the following entry:

swagger.apidocs.enabled=true

To access the Swagger API documentation, use the following URL:

https://your-instance.workfusion.com/workfusion/api/swagger-ui.html