dxp-core/dxp-engine/docs/swagger.json

{
    "swagger": "2.0",
    "info": {
        "contact": {}
    },
    "paths": {
        "/dxp/database/connect": {
            "post": {
                "description": "测试数据库连接",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-数据库连接测试"
                ],
                "summary": "数据库连接测试",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.DbConnInfo"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseAddIndex": {
            "post": {
                "description": "动态添加索引",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-动态添加索引"
                ],
                "summary": "动态添加索引",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.TbIndex"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseCreateTable": {
            "post": {
                "description": "动态创建数据表",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-动态创建数据表"
                ],
                "summary": "动态创建数据表",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.DatabaseCreateRequest"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseDelete": {
            "post": {
                "description": "删除数据库",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-删除数据库"
                ],
                "summary": "删除数据库",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.QueryId"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseDeleteIndex": {
            "post": {
                "description": "动态删除索引",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-动态删除索引"
                ],
                "summary": "动态删除索引",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.TbIndex"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseDeleteTableData": {
            "post": {
                "description": "删除表数据",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-删除表数据"
                ],
                "summary": "删除表数据",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.TbDelete"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseDropTable": {
            "post": {
                "description": "删除数据表",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-删除数据表"
                ],
                "summary": "删除数据表",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.TbDelete"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseInsertData": {
            "post": {
                "description": "动态插入表数据",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-动态插入表数据"
                ],
                "summary": "动态插入表数据",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.ColnDataInsert"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseQueryStatus": {
            "post": {
                "description": "查询数据库连接状态",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-查询数据库连接状态"
                ],
                "summary": "查询数据库连接状态",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.Page"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.CommonList"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseQueryTable": {
            "post": {
                "description": "查询表数据",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-查询表数据"
                ],
                "summary": "查询表数据",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.DbQuery"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.CommonList"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseQueryTableColnList": {
            "post": {
                "description": "查询指定数据库指定表字段",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-查询指定数据库指定表字段"
                ],
                "summary": "查询指定数据库指定表字段",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.QueryTableColn"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.CommonList"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseQueryTableList": {
            "post": {
                "description": "查询指定数据库表结构",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-查询指定数据库表结构"
                ],
                "summary": "查询指定数据库表结构",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.QueryId"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.CommonList"
                        }
                    }
                }
            }
        },
        "/dxp/database/databaseUpdateNotify": {
            "post": {
                "description": "数据库更新通知",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-数据库更新通知"
                ],
                "summary": "数据库更新通知",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{total:0,rows:[]}}",
                        "schema": {
                            "$ref": "#/definitions/model.NullObj"
                        }
                    }
                }
            }
        },
        "/dxp/outapi/any/:key": {
            "post": {
                "description": "数据库资源数据查询",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "第三方接口服务-数据库资源数据查询"
                ],
                "summary": "数据库资源数据查询",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.RequestBody"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{}}",
                        "schema": {
                            "$ref": "#/definitions/model.CommonList"
                        }
                    }
                }
            }
        },
        "/dxp/outapi/authorize": {
            "post": {
                "description": "应用鉴权",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "第三方接口服务-应用鉴权"
                ],
                "summary": "应用鉴权",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.LoginRequest"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{}}",
                        "schema": {
                            "$ref": "#/definitions/model.ResponseToken"
                        }
                    }
                }
            }
        },
        "/dxp/outapi/base/apiCall": {
            "post": {
                "description": "服务测试接口",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "第三方接口服务-服务测试接口"
                ],
                "summary": "服务测试接口",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.ApiTranslateRequest"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{}}",
                        "schema": {
                            "type": "object",
                            "additionalProperties": true
                        }
                    }
                }
            }
        },
        "/dxp/outapi/base/proxyToData/any/:key": {
            "post": {
                "description": "数据库资源数据查询",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-数据库资源数据查询"
                ],
                "summary": "数据库资源数据查询",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.RequestBody"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{}}",
                        "schema": {
                            "$ref": "#/definitions/model.CommonList"
                        }
                    }
                }
            }
        },
        "/dxp/outapi/base/proxyToService/any/:key": {
            "post": {
                "description": "接口服务资源数据查询",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "巨衍接口-接口服务资源数据查询"
                ],
                "summary": "接口服务资源数据查询",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.RequestBody"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{}}",
                        "schema": {
                            "$ref": "#/definitions/model.CommonList"
                        }
                    }
                }
            }
        },
        "/dxp/outapi/refreshToken": {
            "post": {
                "description": "动态刷新token",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "第三方接口服务-动态刷新token"
                ],
                "summary": "动态刷新token",
                "parameters": [
                    {
                        "description": "json",
                        "name": "connect",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/model.RefreshTokenRequest"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"code\": 0, \"msg\": \"xxx\", data:{}}",
                        "schema": {
                            "$ref": "#/definitions/model.ResponseToken"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "model.ApiTranslateRequest": {
            "type": "object",
            "properties": {
                "authWay": {
                    "type": "string"
                },
                "paramForm": {
                    "type": "string"
                },
                "requestMethod": {
                    "type": "string"
                },
                "requestParam": {
                    "type": "string"
                },
                "serviceUrl": {
                    "type": "string"
                }
            }
        },
        "model.ColnDataInsert": {
            "type": "object",
            "properties": {
                "colNameArray": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "id": {
                    "type": "integer"
                },
                "rows": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/model.ColnItem"
                    }
                },
                "tbName": {
                    "type": "string"
                }
            }
        },
        "model.ColnInfo": {
            "type": "object",
            "properties": {
                "colName": {
                    "type": "string"
                },
                "dataLength": {
                    "type": "integer"
                },
                "dataType": {
                    "type": "string"
                },
                "isIncrement": {
                    "type": "integer"
                },
                "isPk": {
                    "description": "是否是主键",
                    "type": "integer"
                },
                "isRequired": {
                    "type": "integer"
                }
            }
        },
        "model.ColnItem": {
            "type": "object",
            "properties": {
                "list": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            }
        },
        "model.CommonList": {
            "type": "object",
            "properties": {
                "list": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": true
                    }
                },
                "total": {
                    "type": "integer"
                }
            }
        },
        "model.DatabaseCreateRequest": {
            "type": "object",
            "properties": {
                "columns": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/model.ColnInfo"
                    }
                },
                "connection": {
                    "type": "string"
                },
                "dbName": {
                    "type": "string"
                },
                "dbType": {
                    "type": "string"
                },
                "id": {
                    "type": "integer"
                },
                "tbName": {
                    "type": "string"
                }
            }
        },
        "model.DbConnInfo": {
            "type": "object",
            "required": [
                "connection",
                "dbName",
                "mode",
                "type"
            ],
            "properties": {
                "connection": {
                    "type": "string"
                },
                "dbName": {
                    "type": "string"
                },
                "id": {
                    "type": "integer"
                },
                "mode": {
                    "description": "连接模式：test:表示测试数据库是否连通，测试完成后自动断开，add表示添加数据库到管理队列。(add之前请先确保数据库已经添加到redis的database hash里面)",
                    "type": "string"
                },
                "type": {
                    "type": "string"
                }
            }
        },
        "model.DbQuery": {
            "type": "object",
            "required": [
                "id",
                "pageNo",
                "pageSize",
                "tbName"
            ],
            "properties": {
                "cols": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "id": {
                    "type": "integer"
                },
                "pageNo": {
                    "type": "integer"
                },
                "pageSize": {
                    "type": "integer"
                },
                "query": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/model.QueryCond"
                    }
                },
                "sort": {
                    "$ref": "#/definitions/model.SortCond"
                },
                "tbName": {
                    "type": "string"
                }
            }
        },
        "model.KeyVal": {
            "type": "object",
            "properties": {
                "keyStr": {
                    "type": "string"
                },
                "keyVal": {
                    "type": "string"
                }
            }
        },
        "model.LoginRequest": {
            "type": "object",
            "properties": {
                "appId": {
                    "type": "string"
                },
                "appSecret": {
                    "type": "string"
                }
            }
        },
        "model.NullObj": {
            "type": "object"
        },
        "model.Page": {
            "type": "object",
            "properties": {
                "pageNo": {
                    "type": "integer"
                },
                "pageSize": {
                    "type": "integer"
                }
            }
        },
        "model.QueryCond": {
            "type": "object",
            "properties": {
                "colName": {
                    "type": "string"
                },
                "colVal": {
                    "type": "string"
                },
                "cond": {
                    "description": "0-等于 1-大于 2-小于",
                    "type": "integer"
                }
            }
        },
        "model.QueryId": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "integer"
                }
            }
        },
        "model.QueryTableColn": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "integer"
                },
                "tableName": {
                    "type": "string"
                }
            }
        },
        "model.RefreshTokenRequest": {
            "type": "object",
            "properties": {
                "refreshToken": {
                    "type": "string"
                }
            }
        },
        "model.RequestBody": {
            "type": "object",
            "properties": {
                "pageNo": {
                    "type": "integer"
                },
                "pageSize": {
                    "type": "integer"
                },
                "search": {
                    "$ref": "#/definitions/model.SearchParam"
                }
            }
        },
        "model.ResponseToken": {
            "type": "object",
            "properties": {
                "accessToken": {
                    "type": "string"
                },
                "expiresAt": {
                    "type": "integer"
                },
                "refreshToken": {
                    "type": "string"
                }
            }
        },
        "model.SearchParam": {
            "type": "object",
            "properties": {
                "and": {
                    "description": "[{\"xml.like\":\"张%\"},{\"xml.eq\":\"张%\"}]",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/model.KeyVal"
                    }
                },
                "or": {
                    "description": "[{\"xml.like\":\"张%\"}]",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/model.KeyVal"
                    }
                }
            }
        },
        "model.SortCond": {
            "type": "object",
            "properties": {
                "colName": {
                    "type": "string"
                },
                "isDesc": {
                    "description": "1-降序  0-升序",
                    "type": "integer"
                }
            }
        },
        "model.TbDelete": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "integer"
                },
                "tbName": {
                    "type": "string"
                }
            }
        },
        "model.TbIndex": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "integer"
                },
                "indexArray": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "tbName": {
                    "type": "string"
                }
            }
        }
    }
}