567 lines
15 KiB
YAML
567 lines
15 KiB
YAML
basePath: /
|
||
definitions:
|
||
base.PageResponse:
|
||
properties:
|
||
current_page:
|
||
description: 当前页码
|
||
type: integer
|
||
data:
|
||
description: 当前页的数据，可以是任意类型的切片
|
||
records_per_page:
|
||
description: 每页记录数
|
||
type: integer
|
||
total_pages:
|
||
description: 总页数
|
||
type: integer
|
||
total_records:
|
||
description: 总记录数
|
||
type: integer
|
||
type: object
|
||
base.Result:
|
||
properties:
|
||
code:
|
||
type: integer
|
||
data: {}
|
||
message:
|
||
type: string
|
||
success:
|
||
type: boolean
|
||
type: object
|
||
flow_definition.ApprovalFlowDTO:
|
||
properties:
|
||
description:
|
||
description: 流程描述
|
||
type: string
|
||
id:
|
||
description: 主键ID
|
||
type: integer
|
||
name:
|
||
description: 流程名称
|
||
type: string
|
||
type: object
|
||
flow_definition.DefinitionQueryParam:
|
||
properties:
|
||
id:
|
||
type: integer
|
||
type: object
|
||
flow_definition.QueryListParam:
|
||
properties:
|
||
page_number:
|
||
description: 当前页码，默认是第一页
|
||
type: integer
|
||
page_size:
|
||
description: 每页记录数，默认是10条
|
||
type: integer
|
||
type: object
|
||
flow_definition.StepAddParam:
|
||
properties:
|
||
flow_id:
|
||
type: integer
|
||
from_step_key:
|
||
type: string
|
||
step_code:
|
||
type: string
|
||
to_step_key:
|
||
type: string
|
||
type: object
|
||
flow_definition.flowDefinitionSaveParam:
|
||
properties:
|
||
description:
|
||
description: 流程描述
|
||
type: string
|
||
name:
|
||
description: 流程名称
|
||
type: string
|
||
type: object
|
||
flow_instance.ApprovalInstanceDTO:
|
||
properties:
|
||
approver_id:
|
||
description: 申请人ID
|
||
type: string
|
||
creator_id:
|
||
description: 创建者ID
|
||
type: string
|
||
current_step_ids:
|
||
description: 当前步骤ID
|
||
items:
|
||
$ref: '#/definitions/flow_instance.CurrentStepDTO'
|
||
type: array
|
||
dynamic_path_configs:
|
||
description: 动态路径配置，自定义，不直接存储
|
||
items:
|
||
$ref: '#/definitions/flow_instance.DynamicPathConfigDTO'
|
||
type: array
|
||
flow_id:
|
||
description: 流程ID
|
||
type: integer
|
||
id:
|
||
description: 主键ID
|
||
type: integer
|
||
status:
|
||
description: 审批状态
|
||
type: string
|
||
steps:
|
||
description: 实例步骤
|
||
items:
|
||
$ref: '#/definitions/flow_instance.InstanceStepDTO'
|
||
type: array
|
||
type: object
|
||
flow_instance.ApprovalRecordDTO:
|
||
properties:
|
||
approver_id:
|
||
description: 审批人ID
|
||
type: string
|
||
comments:
|
||
description: 审批意见
|
||
type: string
|
||
id:
|
||
description: 主键ID
|
||
type: integer
|
||
instance_step_id:
|
||
description: 关联的步骤实例ID
|
||
type: integer
|
||
is_timeout:
|
||
description: 是否超时
|
||
type: boolean
|
||
status:
|
||
description: 审批状态
|
||
type: string
|
||
type: object
|
||
flow_instance.CurrentStepDTO:
|
||
properties:
|
||
current_step_id:
|
||
type: integer
|
||
instance_id:
|
||
type: integer
|
||
type: object
|
||
flow_instance.DynamicPathConfigDTO:
|
||
properties:
|
||
from_step_id:
|
||
description: 来源步骤ID
|
||
type: integer
|
||
id:
|
||
description: 主键ID
|
||
type: integer
|
||
instance_id:
|
||
description: 关联的审批实例ID
|
||
type: integer
|
||
is_parallel:
|
||
description: 是否并行
|
||
type: boolean
|
||
priority:
|
||
description: 路径优先级
|
||
type: integer
|
||
to_step_id:
|
||
description: 目标步骤ID
|
||
type: integer
|
||
type: object
|
||
flow_instance.InstanceStepDTO:
|
||
properties:
|
||
approver_comments:
|
||
description: 审批意见
|
||
type: string
|
||
approver_id:
|
||
description: 审批人ID
|
||
type: string
|
||
id:
|
||
description: 主键ID
|
||
type: integer
|
||
instance_id:
|
||
description: 所属审批实例ID
|
||
type: integer
|
||
is_dynamic:
|
||
description: 是否为动态步骤
|
||
type: boolean
|
||
records:
|
||
description: 审批记录
|
||
items:
|
||
$ref: '#/definitions/flow_instance.ApprovalRecordDTO'
|
||
type: array
|
||
status:
|
||
description: 审批状态
|
||
type: string
|
||
step_id:
|
||
description: 关联的流程步骤ID
|
||
type: integer
|
||
type: object
|
||
flow_instance.InstancesCreateParam:
|
||
properties:
|
||
applicant_key:
|
||
description: 申请人ID
|
||
type: string
|
||
creator_key:
|
||
type: string
|
||
flow_id:
|
||
type: integer
|
||
type: object
|
||
flow_instance.InstancesQueryListParam:
|
||
properties:
|
||
page_number:
|
||
description: 当前页码，默认是第一页
|
||
type: integer
|
||
page_size:
|
||
description: 每页记录数，默认是10条
|
||
type: integer
|
||
type: object
|
||
flow_instance.InstancesQueryParam:
|
||
properties:
|
||
id:
|
||
type: integer
|
||
type: object
|
||
flow_instance.InstancesStartParam:
|
||
properties:
|
||
instance_id:
|
||
type: integer
|
||
type: object
|
||
flow_instance.InstancesStepsAddParam:
|
||
type: object
|
||
flow_instance.InstancesStepsRevertParam:
|
||
type: object
|
||
flow_instance.InstancesStepsUpdateParam:
|
||
type: object
|
||
info:
|
||
contact:
|
||
email: yejianfeng
|
||
name: yejianfeng1
|
||
description: 负责显示审批模块的接口
|
||
license:
|
||
name: Apache 2.0
|
||
url: http://www.apache.org/licenses/LICENSE-2.0.html
|
||
termsOfService: https://github.com/swaggo/swag
|
||
title: hade
|
||
version: "1.1"
|
||
paths:
|
||
/definition/query:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 根据ID查询流程定义详情
|
||
operationId: flow-definition-query
|
||
parameters:
|
||
- description: 查询详情请求参数
|
||
in: body
|
||
name: DefinitionQueryParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_definition.DefinitionQueryParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回成功的流程定义数据
|
||
schema:
|
||
allOf:
|
||
- $ref: '#/definitions/base.Result'
|
||
- properties:
|
||
data:
|
||
$ref: '#/definitions/flow_definition.ApprovalFlowDTO'
|
||
type: object
|
||
"500":
|
||
description: 操作失败
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 查询单个流程定义
|
||
tags:
|
||
- flow-definition
|
||
/definition/query/list:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 获取流程定义列表并支持分页
|
||
operationId: flow-definition-query-list
|
||
parameters:
|
||
- description: 分页查询请求参数
|
||
in: body
|
||
name: QueryListParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_definition.QueryListParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回流程定义分页数据
|
||
schema:
|
||
allOf:
|
||
- $ref: '#/definitions/base.Result'
|
||
- properties:
|
||
data:
|
||
allOf:
|
||
- $ref: '#/definitions/base.PageResponse'
|
||
- properties:
|
||
data:
|
||
items:
|
||
$ref: '#/definitions/flow_definition.ApprovalFlowDTO'
|
||
type: array
|
||
type: object
|
||
type: object
|
||
"500":
|
||
description: 操作失败
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 查询流程定义列表
|
||
tags:
|
||
- flow-definition
|
||
/definition/save:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 创建一个新的流程定义
|
||
operationId: flow-definition-save
|
||
parameters:
|
||
- description: 流程定义保存请求参数
|
||
in: body
|
||
name: flowDefinitionSaveParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_definition.flowDefinitionSaveParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回成功信息
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
"500":
|
||
description: 操作失败
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 保存新的流程定义
|
||
tags:
|
||
- flow-definition
|
||
/definition/step/add:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 根据传入的参数，添加步骤到指定的流程中
|
||
operationId: flow-definition-step-add
|
||
parameters:
|
||
- description: 添加步骤请求参数
|
||
in: body
|
||
name: stepAddParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_definition.StepAddParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 操作成功
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
"400":
|
||
description: 参数错误
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
"500":
|
||
description: 操作失败
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 添加步骤到流程
|
||
tags:
|
||
- flow-definition
|
||
/instances/create:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 通过流程模板创建流程实例
|
||
operationId: instances-create
|
||
parameters:
|
||
- description: 创建参数
|
||
in: body
|
||
name: InstancesCreateParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_instance.InstancesCreateParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回成功的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
"500":
|
||
description: 返回失败的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 创建流程实例
|
||
tags:
|
||
- flow-instances
|
||
/instances/query:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 通过实例的ID查询流程实例详情
|
||
operationId: instances-query
|
||
parameters:
|
||
- description: 查询参数
|
||
in: body
|
||
name: InstancesQueryParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_instance.InstancesQueryParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回成功的流程定义数据
|
||
schema:
|
||
allOf:
|
||
- $ref: '#/definitions/base.Result'
|
||
- properties:
|
||
data:
|
||
$ref: '#/definitions/flow_instance.ApprovalInstanceDTO'
|
||
type: object
|
||
"500":
|
||
description: 返回失败的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 实例查询
|
||
tags:
|
||
- flow-instances
|
||
/instances/query/list:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 输入你的接口总结详情
|
||
operationId: instances-query-list
|
||
parameters:
|
||
- description: 输入参数描述
|
||
in: body
|
||
name: InstancesQueryListParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_instance.InstancesQueryListParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回成功的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
"500":
|
||
description: 返回失败的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 输入你的接口总结
|
||
tags:
|
||
- flow-instances
|
||
/instances/start:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 启动审批流
|
||
operationId: instances-start
|
||
parameters:
|
||
- description: 启动实例ID
|
||
in: body
|
||
name: InstancesStartParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_instance.InstancesStartParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回成功的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
"500":
|
||
description: 返回失败的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 启动审批流
|
||
tags:
|
||
- flow-instances
|
||
/instances/steps/add:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 输入你的接口总结详情
|
||
operationId: instances-steps-add
|
||
parameters:
|
||
- description: 输入参数描述
|
||
in: body
|
||
name: InstancesStepsAddParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_instance.InstancesStepsAddParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回成功的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
"500":
|
||
description: 返回失败的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 输入你的接口总结
|
||
tags:
|
||
- flow-instances
|
||
/instances/steps/revert:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 输入你的接口总结详情
|
||
operationId: instances-steps-revert
|
||
parameters:
|
||
- description: 输入参数描述
|
||
in: body
|
||
name: InstancesStepsRevertParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_instance.InstancesStepsRevertParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回成功的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
"500":
|
||
description: 返回失败的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 输入你的接口总结
|
||
tags:
|
||
- flow-instances
|
||
/instances/steps/update:
|
||
post:
|
||
consumes:
|
||
- application/json
|
||
description: 输入你的接口总结详情
|
||
operationId: instances-steps-update
|
||
parameters:
|
||
- description: 输入参数描述
|
||
in: body
|
||
name: InstancesStepsUpdateParam
|
||
required: true
|
||
schema:
|
||
$ref: '#/definitions/flow_instance.InstancesStepsUpdateParam'
|
||
produces:
|
||
- application/json
|
||
responses:
|
||
"200":
|
||
description: 返回成功的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
"500":
|
||
description: 返回失败的流程定义数据
|
||
schema:
|
||
$ref: '#/definitions/base.Result'
|
||
summary: 输入你的接口总结
|
||
tags:
|
||
- flow-instances
|
||
securityDefinitions:
|
||
ApiKeyAuth:
|
||
in: header
|
||
name: Authorization
|
||
type: apiKey
|
||
BasicAuth:
|
||
type: basic
|
||
swagger: "2.0"
|
||
x-extension-openapi:
|
||
example: value on a json format
|