How to expose swagger docs with spring boot?

Flowable Engine
1

Hi, I am new to flwoable.

I am using flowable flowable-spring-boot-starter-rest 7.1.0 with Spring Boot 3.

I can access the rest api endpoints, but how can I get swagger docs embedded in my spring boot application too ?

2

add the springdoc‑openapi dependency to your project (for Maven, add it to your pom.xml):

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.0.2</version>
</dependency>

your application.properties (or application.yml):
springdoc.packages-to-scan=org.flowable.rest
After starting your application, the Swagger UI should be available at:
http://localhost:8080/swagger-ui/index.html
:grinning_face:

3

Thanks! what’s the urls for flowable’s api ?

4

for anyone want to do the same:

  1. import swagger-maven-plugin just like what flowable-rest do, you can copy code from github
  2. generate swagger spec files
  3. import springdoc-openapi-starter-webmvc-ui dependency
  4. don’t forget add fileset in maven clean plugin.

spring boot configs:

flowable:
  rest:
    app:
      swagger-docs-enabled: true
springdoc:
  package-to-scan: org.acme.app.xx # for the API of your own application expose
  api-docs:
    path: /v3/api-docs # for the API of your own application expose
  swagger-ui:
    path: /swagger-ui.html 
    disable-swagger-default-url: true
    urls:
      - name: process
        url: /docs/specfile/process/flowable-swagger-process.json
      - name: idm
        url: /docs/specfile/idm/flowable-swagger-idm.json
      - name: myapi
        url: /v3/api-docs

for the API of your own application expose, I am letting springdoc generate API spec file at runtime, you can also generate the API spec file at compile time, depends on it’s OpenAPI 2 or 3, you may use different maven plugin to do this.