Swagger configuration

Swagger auto-generated documentation for Spring-based REST API is configured in Workfusion with regard to Springfox libraries. Being enabled via specific property, it requires a standard login to the WorkFusion platform. The documentation allows to examine all available public API endpoints with calls description and even execute selected requests pressing the Try it out! button.

How to enable Swagger?

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

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

with the following entry:

swagger.apidocs.enabled=true

Which URL to use to access Swagger documentation?

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