swagger.json 8.4 KB
Newer Older
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
1 2 3
{
    "swagger": "2.0",
    "info": {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
4 5
        "description": "This is a sample Server pets",
        "title": "Swagger Example API",
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
6
        "contact": {},
Mr.奇淼('s avatar
Mr.奇淼( 已提交
7 8
        "license": {},
        "version": "0.0.1"
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
9
    },
Mr.奇淼('s avatar
Mr.奇淼( 已提交
10
    "basePath": "/",
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
11
    "paths": {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
12
        "/base/login": {
13 14 15 16 17
            "post": {
                "produces": [
                    "application/json"
                ],
                "tags": [
Mr.奇淼('s avatar
Mr.奇淼( 已提交
18
                    "Base"
19
                ],
Mr.奇淼('s avatar
Mr.奇淼( 已提交
20
                "summary": "用户登录",
21 22
                "parameters": [
                    {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
23
                        "description": "用户登录接口",
24 25 26 27 28
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
Mr.奇淼('s avatar
Mr.奇淼( 已提交
29
                            "$ref": "#/definitions/api.RegistAndLoginStuct"
30 31 32 33 34
                        }
                    }
                ],
                "responses": {
                    "200": {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
35
                        "description": "{\"success\":true,\"data\":{},\"msg\":\"登陆成功\"}",
36 37 38 39 40 41 42
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
Mr.奇淼('s avatar
Mr.奇淼( 已提交
43
        "/base/regist": {
44 45 46 47 48
            "post": {
                "produces": [
                    "application/json"
                ],
                "tags": [
Mr.奇淼('s avatar
Mr.奇淼( 已提交
49
                    "Base"
50
                ],
Mr.奇淼('s avatar
Mr.奇淼( 已提交
51
                "summary": "用户注册账号",
52 53
                "parameters": [
                    {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
54
                        "description": "用户注册接口",
55 56 57 58 59 60 61 62 63 64 65
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
                            "$ref": "#/definitions/api.RegistAndLoginStuct"
                        }
                    }
                ],
                "responses": {
                    "200": {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
66
                        "description": "{\"success\":true,\"data\":{},\"msg\":\"注册成功\"}",
67 68 69 70 71 72 73
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
Mr.奇淼('s avatar
Mr.奇淼( 已提交
74
        "/menu/getMenu": {
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
75
            "post": {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
76 77 78 79 80
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
81
                "produces": [
82
                    "application/json"
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
83
                ],
84
                "tags": [
Mr.奇淼('s avatar
Mr.奇淼( 已提交
85
                    "Menu"
86
                ],
Mr.奇淼('s avatar
Mr.奇淼( 已提交
87
                "summary": "获取用户动态路由",
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
88 89
                "parameters": [
                    {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
90
                        "description": "可以什么都不填",
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
91 92 93 94 95
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
96
                            "$ref": "#/definitions/api.RegistAndLoginStuct"
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
97 98 99 100 101
                        }
                    }
                ],
                "responses": {
                    "200": {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
                        "description": "{\"success\":true,\"data\":{},\"msg\":\"返回成功\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/user/changePassWord": {
            "post": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "User"
                ],
                "summary": "用户修改密码",
                "parameters": [
                    {
                        "description": "用户修改密码",
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
                            "$ref": "#/definitions/api.ChangePassWordStutrc"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"success\":true,\"data\":{},\"msg\":\"修改成功\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
        },
        "/user/getInfoList": {
            "post": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "User"
                ],
                "summary": "分页获取用户列表",
                "parameters": [
                    {
                        "description": "分页获取用户列表",
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
                            "$ref": "#/definitions/modelInterface.PageInfo"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"success\":true,\"data\":{},\"msg\":\"获取成功\"}",
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
178 179 180 181 182 183
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
184 185 186
        },
        "/user/uploadHeaderImg": {
            "post": {
Mr.奇淼('s avatar
Mr.奇淼( 已提交
187 188 189 190 191
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
                "consumes": [
                    "multipart/form-data"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "User"
                ],
                "summary": "用户上传头像",
                "parameters": [
                    {
                        "type": "file",
                        "description": "用户上传头像",
                        "name": "headerImg",
                        "in": "formData",
                        "required": true
                    },
                    {
                        "type": "string",
                        "description": "用户上传头像",
                        "name": "userName",
                        "in": "formData",
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "{\"success\":true,\"data\":{},\"msg\":\"上传成功\"}",
                        "schema": {
                            "type": "string"
                        }
                    }
                }
            }
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
227 228 229
        }
    },
    "definitions": {
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
        "api.ChangePassWordStutrc": {
            "type": "object",
            "properties": {
                "newPassWord": {
                    "type": "string"
                },
                "passWord": {
                    "type": "string"
                },
                "userName": {
                    "type": "string"
                }
            }
        },
        "api.RegistAndLoginStuct": {
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
245 246 247 248 249 250 251 252 253
            "type": "object",
            "properties": {
                "passWord": {
                    "type": "string"
                },
                "userName": {
                    "type": "string"
                }
            }
Mr.奇淼('s avatar
Mr.奇淼( 已提交
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
        },
        "modelInterface.PageInfo": {
            "type": "object",
            "properties": {
                "page": {
                    "type": "integer"
                },
                "pageSize": {
                    "type": "integer"
                }
            }
        }
    },
    "securityDefinitions": {
        "ApiKeyAuth": {
            "type": "apiKey",
            "name": "x-token",
            "in": "header"
Mr.奇淼('s avatar
swagger  
Mr.奇淼( 已提交
272 273 274
        }
    }
}