swagger.yaml 15.4 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 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 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
swagger: "2.0"
info:
  title: ""
  description: 开发工具平台
  contact:
    name: tiptok
    email: 785409885@qq.com
    home: ""
  version: 0.0.1
consumes:
- application/json
- application/xml
produces:
- application/json
- application/xml
paths:
  /auth/login:
    post:
      tags:
      - auth
      summary: 登录
      description: 登录
      operationId: auth#login
      parameters:
      - name: LoginRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/AuthLoginRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/AuthLoginResponseBody'
      schemes:
      - http
  /auth/profile:
    post:
      tags:
      - auth
      summary: 获得当前用户数据
      description: 获得当前用户数据
      operationId: auth#profile
      parameters:
      - name: ProfileRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/AuthProfileRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/AuthProfileResponseBody'
      schemes:
      - http
  /auth/refresh:
    post:
      tags:
      - auth
      summary: 刷新权限
      description: 刷新权限
      operationId: auth#refresh
      parameters:
      - name: RefreshRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/AuthRefreshRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/AuthRefreshResponseBody'
      schemes:
      - http
  /roles:
    get:
      tags:
      - role
      summary: 返回列表
      description: 返回列表
      operationId: role#listRole
      parameters:
      - name: offset
        in: query
        description: 查询偏离量
        required: false
        type: integer
      - name: limit
        in: query
        description: 查询限制
        required: false
        type: integer
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/RoleListRoleResponseBody'
      schemes:
      - http
    post:
      tags:
      - role
      summary: 创建
      description: 创建
      operationId: role#createRole
      parameters:
      - name: CreateRoleRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/RoleCreateRoleRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/RoleCreateRoleResponseBody'
      schemes:
      - http
  /roles/{Id}:
    get:
      tags:
      - role
      summary: 返回
      description: 返回
      operationId: role#getRole
      parameters:
      - name: Id
        in: path
        required: true
        type: string
      - name: GetRoleRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/RoleGetRoleRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/RoleGetRoleResponseBody'
      schemes:
      - http
    put:
      tags:
      - role
      summary: 更新
      description: 更新
      operationId: role#updateRole
      parameters:
      - name: Id
        in: path
        required: true
        type: string
      - name: UpdateRoleRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/RoleUpdateRoleRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/RoleUpdateRoleResponseBody'
      schemes:
      - http
    delete:
      tags:
      - role
      summary: 移除
      description: 移除
      operationId: role#removeRole
      parameters:
      - name: Id
        in: path
        required: true
        type: string
      - name: RemoveRoleRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/RoleRemoveRoleRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/RoleRemoveRoleResponseBody'
      schemes:
      - http
  /users:
    get:
      tags:
      - users
      summary: 返回列表
      description: 返回列表
      operationId: users#listUsers
      parameters:
      - name: offset
        in: query
        description: 查询偏离量
        required: false
        type: integer
      - name: limit
        in: query
        description: 查询限制
        required: false
        type: integer
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/UsersListUsersResponseBody'
      schemes:
      - http
    post:
      tags:
      - users
      summary: 创建
      description: 创建
      operationId: users#createUsers
      parameters:
      - name: CreateUsersRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/UsersCreateUsersRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/UsersCreateUsersResponseBody'
      schemes:
      - http
  /users/{Id}:
    get:
      tags:
      - users
      summary: 返回
      description: 返回
      operationId: users#getUsers
      parameters:
      - name: Id
        in: path
        required: true
        type: string
      - name: GetUsersRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/UsersGetUsersRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/UsersGetUsersResponseBody'
      schemes:
      - http
    put:
      tags:
      - users
      summary: 更新
      description: 更新
      operationId: users#updateUsers
      parameters:
      - name: Id
        in: path
        required: true
        type: string
      - name: UpdateUsersRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/UsersUpdateUsersRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/UsersUpdateUsersResponseBody'
      schemes:
      - http
    delete:
      tags:
      - users
      summary: 移除
      description: 移除
      operationId: users#removeUsers
      parameters:
      - name: Id
        in: path
        required: true
        type: string
      - name: RemoveUsersRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/UsersRemoveUsersRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/UsersRemoveUsersResponseBody'
      schemes:
      - http
definitions:
  AuthLoginRequestBody:
    title: AuthLoginRequestBody
    type: object
    properties:
      password:
        type: string
        description: 密码
        required:
        - password
      username:
        type: string
        description: 用户名
        required:
        - username
  AuthLoginResponseBody:
    title: 'Mediatype identifier: AuthLoginResponseBody'
    type: object
    properties:
      access:
        $ref: '#/definitions/authAccessResponseBody'
  AuthProfileRequestBody:
    title: AuthProfileRequestBody
    type: object
    properties:
      userId:
        type: integer
        required:
        - userId
  AuthProfileResponseBody:
    title: 'Mediatype identifier: AuthProfileResponseBody'
    type: object
    properties:
      menus:
        type: array
        items:
          $ref: '#/definitions/menuResponseBody'
      user:
        $ref: '#/definitions/authUserResponseBody'
  AuthRefreshRequestBody:
    title: AuthRefreshRequestBody
    type: object
    properties:
      refreshToken:
        type: string
        required:
        - refreshToken
  AuthRefreshResponseBody:
    title: 'Mediatype identifier: AuthRefreshResponseBody'
    type: object
    properties:
      access:
        $ref: '#/definitions/authAccessResponseBody'
  RoleCreateRoleRequestBody:
    title: RoleCreateRoleRequestBody
    type: object
    properties:
      Id:
        type: integer
        description: 角色id
        required:
        - Id
      RoleName:
        type: string
        description: 角色名称
  RoleCreateRoleResponseBody:
    title: 'Mediatype identifier: RoleCreateRoleResponseBody'
    type: object
    properties:
      role:
        $ref: '#/definitions/roleResponseBody'
  RoleGetRoleRequestBody:
    title: RoleGetRoleRequestBody
    type: object
    properties:
      RoleId:
        type: integer
        description: 角色id
        required:
        - RoleId
  RoleGetRoleResponseBody:
    title: 'Mediatype identifier: RoleGetRoleResponseBody'
    type: object
    properties:
      role:
        $ref: '#/definitions/roleResponseBody'
  RoleListRoleResponseBody:
    title: 'Mediatype identifier: RoleListRoleResponseBody'
    type: object
    properties:
      count:
        type: integer
        description: 匹配数目
        required:
        - count
      role:
        $ref: '#/definitions/roleResponseBody'
  RoleRemoveRoleRequestBody:
    title: RoleRemoveRoleRequestBody
    type: object
    properties:
      RoleId:
        type: integer
        description: 角色id
        required:
        - RoleId
  RoleRemoveRoleResponseBody:
    title: 'Mediatype identifier: RoleRemoveRoleResponseBody'
    type: object
    properties:
      role:
        $ref: '#/definitions/roleResponseBody'
  RoleUpdateRoleRequestBody:
    title: RoleUpdateRoleRequestBody
    type: object
    properties:
      RoleId:
        type: integer
        description: 角色id
        required:
        - RoleId
  RoleUpdateRoleResponseBody:
    title: 'Mediatype identifier: RoleUpdateRoleResponseBody'
    type: object
    properties:
      role:
        $ref: '#/definitions/roleResponseBody'
  UsersCreateUsersRequestBody:
    title: UsersCreateUsersRequestBody
    type: object
    properties:
      name:
        type: string
        required:
        - name
      phone:
        type: string
        required:
        - phone
  UsersCreateUsersResponseBody:
    title: 'Mediatype identifier: UsersCreateUsersResponseBody'
    type: object
    properties:
      users:
        $ref: '#/definitions/usersResponseBody'
  UsersGetUsersRequestBody:
    title: UsersGetUsersRequestBody
    type: object
    properties:
      usersId:
        type: integer
        description: user - id
        required:
        - usersId
  UsersGetUsersResponseBody:
    title: 'Mediatype identifier: UsersGetUsersResponseBody'
    type: object
    properties:
      users:
        $ref: '#/definitions/usersResponseBody'
  UsersListUsersResponseBody:
    title: 'Mediatype identifier: UsersListUsersResponseBody'
    type: object
    properties:
      count:
        type: integer
        description: 匹配数目
        required:
        - count
      users:
        $ref: '#/definitions/usersResponseBody'
  UsersRemoveUsersRequestBody:
    title: UsersRemoveUsersRequestBody
    type: object
    properties:
      usersId:
        type: integer
        description: user - id
        required:
        - usersId
  UsersRemoveUsersResponseBody:
    title: 'Mediatype identifier: UsersRemoveUsersResponseBody'
    type: object
    properties:
      users:
        $ref: '#/definitions/usersResponseBody'
  UsersUpdateUsersRequestBody:
    title: UsersUpdateUsersRequestBody
    type: object
    properties:
      usersId:
        type: integer
        description: user - id
        required:
        - usersId
  UsersUpdateUsersResponseBody:
    title: 'Mediatype identifier: UsersUpdateUsersResponseBody'
    type: object
    properties:
      users:
        $ref: '#/definitions/usersResponseBody'
  authAccessResponseBody:
    title: authAccessResponseBody
    type: object
    properties:
      accessToken:
        type: string
        description: 权限token
        required:
        - accessToken
      expiresIn:
        type: string
        description: accessToken 过期时间
        required:
        - expiresIn
      refreshToken:
        type: string
        description: 刷新token
        required:
        - refreshToken
    description: 权限
  authRoleResponseBody:
    title: authRoleResponseBody
    type: object
    properties:
      id:
        type: string
        description: 角色id
      name:
        type: string
        description: 角色名称
    description: 权限角色
  authUserResponseBody:
    title: authUserResponseBody
    type: object
    properties:
      adminType:
        type: integer
        description: 管理员类型 1:超级管理员 2:普通账号
        format: int64
      id:
        type: integer
        description: 用户id
        format: int64
      name:
        type: string
        description: 名称
      phone:
        type: string
        description: 电话
      roles:
        type: array
        items:
          $ref: '#/definitions/authRoleResponseBody'
        description: 角色列表
    description: 权限用户
  menuResponseBody:
    title: menuResponseBody
    type: object
    properties:
      code:
        type: string
        description: 菜单code
      icon:
        type: string
        description: 图标地址
      id:
        type: integer
        description: 编号
        format: int64
      name:
        type: string
        description: 菜单名称
      parentId:
        type: integer
        description: 父级id
        format: int64
      sort:
        type: integer
        description: 排序
        format: int64
      status:
        type: integer
        description: 状态 1-启用 0-禁用
        format: int64
    description: 菜单
  roleResponseBody:
    title: roleResponseBody
    type: object
    properties:
      CreateTime:
        type: string
        description: 创建时间
        required:
        - CreateTime
      Id:
        type: integer
        description: dcc
        required:
        - Id
      ParentId:
        type: integer
        description: 父级Id
        required:
        - ParentId
      RoleName:
        type: string
        description: 角色名称
        required:
        - RoleName
      UpdateTime:
        type: string
        description: 更新时间
        required:
        - UpdateTime
    description: 角色实体
  usersResponseBody:
    title: usersResponseBody
    type: object
    properties:
      AdminType:
        type: integer
        description: 1:管理员  2:普通员工
        required:
        - AdminType
      CreateTime:
        type: string
        description: 创建时间
        required:
        - CreateTime
      Id:
        type: integer
        description: dcc
        required:
        - Id
      Name:
        type: string
        description: 名称
        required:
        - Name
      Passwd:
        type: string
        description: 密码
        required:
        - Passwd
      Phone:
        type: string
        description: 手机号
        required:
        - Phone
      Roles:
        type: array
        items:
          type: integer
          format: int64
        description: 用户角色
        required:
        - Roles
      Status:
        type: integer
        description: 状态 1-启用 0-禁用
        required:
        - Status
      UpdateTime:
        type: string
        description: 更新时间
        required:
        - UpdateTime
    description: 用户实体