approveflow/app/http/swagger/swagger.json

1078 lines
37 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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