# Flowable 整合 Swagger UI

**Repository Path**: markix/flowable-swagger

## Basic Information

- **Project Name**: Flowable 整合 Swagger UI
- **Description**: Flowable 整合 Swagger 的自动化配置组件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-04-28
- **Last Updated**: 2024-03-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 简介
该项目实现了 Flowable 整合 Swagger 的自动化配置。

# 实现
**基本情况**
- 我们启动的应用为'主应用上下文'；Flowable每个Rest模块都是一个独立的'子应用上下文'。
- Swagger只能获取到'当前应用上下文'的接口信息，也就是说在'主应用上下文'启用的Swagger（@EnableSwagger2）无法获取到'子应用上下文'的接口信息。

**实现思路**
- 在各个'子应用上下文'的扫描路径中添加配置类，启用Swagger；
- 覆盖'主应用上下文'中的Swagger资源提供者（SwaggerResourcesProvider），聚合'子应用上下文'中的Swagger资源。

## 基础依赖
- Swagger：2.9.2

# 配置
```yaml
flowable:
  swagger:
    enabled: true #是否启用 Flowable 的 Swagger
    # 细粒度控制各模块的Swagger启用状态
    process.enabled: true
    idm.enabled: true
    cmmn.enabled: true
    content.enabled: true
    app.enabled: true
    form.enabled: true
    dmn.enabled: true
    event-registry.enabled: true
    external-job.enabled: true

flowable-ui:
  swagger:
    enabled: true #是否启用 Flowable UI 的 Swagger
    # 细粒度控制各App的Swagger启用状态
    admin.enabled: true
    idm.enabled: true
    idm-api.enabled: true
    modeler.enabled: true
    modeler-api.enabled: true
```

# 使用
- 在`pom.xml`中引入依赖即可
```xml
<dependency>
    <groupId>io.github.markixy</groupId>
    <artifactId>flowable-swagger</artifactId>
    <version>1.0.2</version>
</dependency>
```
若重新打包则会更新到依赖版本，最新版本详见 [https://search.maven.org/artifact/io.github.markixy/flowable-swagger](https://search.maven.org/artifact/io.github.markixy/flowable-swagger)

# 更新历史
见 [change-log.md](change-log.md)