We’ve just put the finishing touches on the first version of the Swagger integration for the Flowable REST API (look for the ‘swagger-integration’ branch in the Flowable Github repository that soon will be merged to master). More and more libraries and frameworks are adding Swagger support nowadays.
For those who don’t know Swagger: it is a standard specification that is part of the OpenAPI initiative. The core of Swagger is a so-called specfile which is a json (or yaml) document that describes and documents for example a REST API. By using Swagger annotations on our Spring MVC REST controllers, the docs and logic stay close together so it’s easy to maintain. A Maven plugin then processes these annotations and generates this specfile.
The benefits of Swagger are quite clear:
By doing this Swagger integration, we’ve found some places in the REST API that could be improved or should evolve, which we’ll tackle in the next coming releases. Of course, we’re very interesting in your feedback: what’s good, what’s bad, what’s missing and what would be cool to add!