Swagger REST API definitions in flowable 6.3.0 - incompletely generated?

n0n1ck · April 16, 2018, 6:32pm

It seems to me in Flowable v6.3.0 with the “flowable-rest.war” the wrong swagger specfiles are distributed/generated in
“WEB-INF/classes/static/docs/specfile”
for the “content”, “dmn”, “form” and “idm” API.

For example

github.com

flowable/flowable-engine/blob/flowable-6.3.0/docs/public-api/references/swagger/form/flowable-swagger-form.yaml

---
swagger: "2.0"
info:
  description: "# flowable / flow??b(??)l /\n\n- a compact and highly efficient workflow\
    \ and Business Process Management (BPM) platform for developers, system admins\
    \ and business users.\n- a lightning fast, tried and tested BPMN 2 process engine\
    \ written in Java. It is Apache 2.0 licensed open source, with a committed community.\n\
    - can run embedded in a Java application, or as a service on a server, a cluster,\
    \ and in the cloud. It integrates perfectly with Spring. With a rich Java and\
    \ REST API, it is the ideal engine for orchestrating human or system activities."
  version: "v1"
  title: "Flowable Form REST API"
  contact:
    name: "Flowable"
    url: "http://www.flowable.org/"
  license:
    name: "Apache 2.0"
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "localhost:8080"
basePath: "/flowable-rest/form-api"

This file has been truncated. show original

seem correct/complete to me - perhaps a “contract first” approach for the future?

In the build process of “flowable-app-rest” module the swagger-maven-plugin is used to generate a swagger API description for the form API based on
org.flowable.rest.form.service.api
which results in a generated swagger definition with no endpoints included, whereas
org.flowable.rest.service.api
seems to work and produces a meaningful definition with lots of endpoints/resources.

The corresponding swagger definitions are served from the “flowable-rest” app on
flowable-rest/docs/specfile/form/flowable.yaml
and
flowable-rest/docs/specfile/process/flowable.yaml

I don’t yet understand the “big-picture” from an architectural point of view, so probably I miss out a important detail.

Hope you can enlighten

Regards, Andreas.

Heurazio · April 20, 2018, 11:08am

Can confirm this problem. Are there any news?

filiphr · April 20, 2018, 11:24am

It seems that they are missing. This is a mistake on our side. I have created #1008 in order to fix this

Topic		Replies	Views
Swagger UI not working in Flowable REST API 6.0.0 Flowable Engine	4	4864	May 17, 2017
Flowable client SDK with swagger or feign Flowable Engine	4	1224	February 4, 2017
Update Definition Flowable Engine	1	670	March 5, 2020
REST API for APPS definitions - swagger/openapi Flowable Engine	1	797	June 18, 2019
Wrapper for .net	2	1629	October 5, 2017

Swagger REST API definitions in flowable 6.3.0 - incompletely generated?

Related topics