egg_app/docs/swagger.json

{
    "swagger": "2.0",
    "info": {
        "description": "管理后台接口文档",
        "title": "蛋蛋星球-管理后台",
        "termsOfService": "http://swagger.io/terms/",
        "contact": {
            "name": "dengbiao",
            "url": "http://www.swagger.io/support",
            "email": "1239118001@qq.com"
        },
        "license": {
            "name": "Apache 2.0",
            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
        },
        "version": "1.0"
    },
    "host": "localhost:4001",
    "paths": {
        "/api/demo": {
            "post": {
                "description": "Demo样例测试",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "Demo"
                ],
                "summary": "Demo测试",
                "parameters": [
                    {
                        "description": "用户名密码",
                        "name": "req",
                        "in": "body",
                        "required": true,
                        "schema": {}
                    }
                ],
                "responses": {
                    "200": {
                        "description": "token",
                        "schema": {
                            "type": "object",
                            "additionalProperties": true
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/communityDividends/communityDividendsAdd": {
            "post": {
                "description": "社区分红(新增)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-社区分红(新增)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    },
                    {
                        "description": "分红名称、分红总量",
                        "name": "req",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/md.AddCommunityDividendsReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "插入数据 ID",
                        "schema": {
                            "type": "int"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/communityDividends/communityDividendsWithUserAdd": {
            "post": {
                "description": "社区长列表(新增)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-社区长列表(新增)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    },
                    {
                        "description": "新增社区长 ID、备注",
                        "name": "req",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/md.AddCommunityDividendsWithUserReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "插入数据 ID",
                        "schema": {
                            "type": "int"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/exchangeUserPosition": {
            "post": {
                "description": "关系分布图(位置转换)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-关系分布图(位置转换)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    },
                    {
                        "description": "需要交换的两个位置",
                        "name": "req",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/md.ExchangeUserPositionReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功返回",
                        "schema": {
                            "type": ""
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/findSubUserRelationshipMap": {
            "get": {
                "description": "关系分布图(获取指定用户上级)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-关系分布图(获取指定用户上级)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "用户ID",
                        "name": "uid",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "具体数据",
                        "schema": {
                            "$ref": "#/definitions/md.TreeNode"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/findUserRelationshipMap": {
            "get": {
                "description": "关系分布图(获取指定用户下级)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-关系分布图(获取指定用户下级)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "用户ID",
                        "name": "uid",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "具体数据",
                        "schema": {
                            "$ref": "#/definitions/md.TreeNode"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/getBasic": {
            "get": {
                "description": "公排基础设置(获取)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-公排基础设置(获取)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "具体数据",
                        "schema": {
                            "$ref": "#/definitions/md.GetPublicPlatoonBasicResp"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/publicPlatoonUserFreePunish/index": {
            "post": {
                "description": "免罚用户(查询)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-免罚用户(查询)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    },
                    {
                        "description": "页数和行数必填，uid选填",
                        "name": "req",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/md.GetFreePublishUserReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功返回",
                        "schema": {
                            "$ref": "#/definitions/md.GetFreePublishUserResp"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/publicPlatoonUserFreePunish/save": {
            "post": {
                "description": "免罚用户(新增)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-免罚用户(新增)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    },
                    {
                        "description": "页数和行数必填，uid选填",
                        "name": "req",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/md.AddFreePublishUserReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "插入数据 ID",
                        "schema": {
                            "type": "int"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/relationshipMap": {
            "get": {
                "description": "关系分布图(获取)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-关系分布图(获取)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "phone",
                        "name": "phone",
                        "in": "query",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "uid",
                        "name": "uid",
                        "in": "query",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "具体数据",
                        "schema": {
                            "$ref": "#/definitions/md.TreeNode"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/institutionalManagement/publicPlatoon/updateBasic": {
            "put": {
                "description": "公排基础设置(修改)",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "公排管理"
                ],
                "summary": "制度中心-公排管理-公排基础设置(修改)",
                "parameters": [
                    {
                        "type": "string",
                        "description": "验证参数Bearer和token空格拼接",
                        "name": "Authorization",
                        "in": "header",
                        "required": true
                    },
                    {
                        "description": "公排设置表单内容",
                        "name": "req",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/md.UpdatePublicPlatoonBasicReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "success",
                        "schema": {
                            "type": "string"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        },
        "/api/login": {
            "post": {
                "description": "登入",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "登录"
                ],
                "summary": "登陆",
                "parameters": [
                    {
                        "description": "用户名密码",
                        "name": "req",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/md.LoginReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "token",
                        "schema": {
                            "$ref": "#/definitions/md.LoginResponse"
                        }
                    },
                    "400": {
                        "description": "具体错误",
                        "schema": {
                            "$ref": "#/definitions/md.Response"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "md.AddCommunityDividendsReq": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string"
                },
                "nums": {
                    "type": "integer"
                }
            }
        },
        "md.AddCommunityDividendsWithUserReq": {
            "type": "object",
            "properties": {
                "memo": {
                    "type": "string"
                },
                "uid": {
                    "type": "integer"
                }
            }
        },
        "md.AddFreePublishUserReq": {
            "type": "object",
            "properties": {
                "uid": {
                    "type": "integer"
                }
            }
        },
        "md.ExchangeUserPositionReq": {
            "type": "object",
            "properties": {
                "position_1": {
                    "description": "位置1，具体值取返回数据中的 system_id",
                    "type": "integer"
                },
                "position_2": {
                    "description": "位置2，具体值取返回数据中的 system_id",
                    "type": "integer"
                }
            }
        },
        "md.FreePublishUserNode": {
            "type": "object",
            "properties": {
                "nickname": {
                    "type": "string"
                },
                "phone": {
                    "type": "string"
                },
                "uid": {
                    "type": "integer"
                }
            }
        },
        "md.GetFreePublishUserReq": {
            "type": "object",
            "properties": {
                "limit": {
                    "type": "integer"
                },
                "page": {
                    "type": "integer"
                },
                "uid": {
                    "type": "integer"
                }
            }
        },
        "md.GetFreePublishUserResp": {
            "type": "object",
            "properties": {
                "list": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/md.FreePublishUserNode"
                    }
                },
                "paginate": {
                    "$ref": "#/definitions/md.Paginate"
                }
            }
        },
        "md.GetPublicPlatoonBasicResp": {
            "type": "object",
            "properties": {
                "is_open": {
                    "type": "integer"
                },
                "is_self_active_get_team_revenue": {
                    "type": "integer"
                },
                "originator_uid": {
                    "type": "integer"
                },
                "several_rows": {
                    "type": "integer"
                },
                "several_times": {
                    "type": "integer"
                },
                "system_punish_replace": {
                    "type": "integer"
                },
                "system_punish_replace_value": {
                    "type": "integer"
                }
            }
        },
        "md.LoginReq": {
            "type": "object",
            "required": [
                "password",
                "username"
            ],
            "properties": {
                "code": {
                    "type": "string",
                    "example": "验证码"
                },
                "password": {
                    "type": "string",
                    "example": "登录密码"
                },
                "username": {
                    "type": "string",
                    "example": "登录账号"
                }
            }
        },
        "md.LoginResponse": {
            "type": "object",
            "properties": {
                "token": {
                    "type": "string"
                }
            }
        },
        "md.Paginate": {
            "type": "object",
            "properties": {
                "limit": {
                    "type": "integer"
                },
                "page": {
                    "type": "integer"
                },
                "total": {
                    "type": "integer"
                }
            }
        },
        "md.Response": {
            "type": "object",
            "properties": {
                "code": {
                    "type": "string",
                    "example": "响应码"
                },
                "data": {
                    "description": "内容"
                },
                "msg": {
                    "type": "string",
                    "example": "具体错误原因"
                }
            }
        },
        "md.TreeNode": {
            "type": "object",
            "properties": {
                "avatar_url": {
                    "type": "string",
                    "example": "头像"
                },
                "level": {
                    "type": "integer"
                },
                "nickname": {
                    "type": "string",
                    "example": "昵称"
                },
                "phone": {
                    "type": "string",
                    "example": "手机号"
                },
                "pid": {
                    "type": "integer"
                },
                "position": {
                    "type": "integer"
                },
                "son": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/md.TreeNode"
                    }
                },
                "system_id": {
                    "description": "公排网中id",
                    "type": "integer"
                },
                "uid": {
                    "type": "integer"
                }
            }
        },
        "md.UpdatePublicPlatoonBasicReq": {
            "type": "object",
            "properties": {
                "is_open": {
                    "type": "integer"
                },
                "is_self_active_get_team_revenue": {
                    "type": "integer"
                },
                "originator_uid": {
                    "type": "integer"
                },
                "several_rows": {
                    "type": "integer"
                },
                "several_times": {
                    "type": "integer"
                },
                "system_punish_replace": {
                    "type": "integer"
                },
                "system_punish_replace_value": {
                    "type": "integer"
                }
            }
        }
    },
    "securityDefinitions": {
        "MasterID": {
            "type": "apiKey",
            "name": "MasterID",
            "in": "header"
        }
    }
}