shop/docs/swagger.yaml

167 lines
3.7 KiB
YAML

info:
contact: {}
license: {}
paths:
/admin/login:
get:
parameters:
- description: 用户名
in: query
name: username
required: true
type: string
- description: 密码
in: query
name: password
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"code":200,"data":{},"msg":"ok"}'
schema:
type: string
summary: 后台登录
/admin/v1/employees:
get:
consumes:
- application/json
parameters:
- description: auth by /admin/login
in: header
name: Authorization
required: true
type: string
- description: Department
in: query
name: department
type: string
- description: Position
in: query
name: position
type: string
- description: State
in: query
name: state
type: integer
produces:
- application/json
responses:
"200":
description: '{"code": 200, "data": {}, "msg":"ok"}'
schema:
type: string
summary: 获取员工列表
tags:
- employees
post:
consumes:
- multipart/form-data
parameters:
- description: auth by /admin/login
in: header
name: Authorization
required: true
type: string
- description: 员工用户名
in: formData
name: username
required: true
type: string
- description: 员工密码
in: formData
name: password
required: true
type: string
- description: 员工部门
in: formData
name: department
required: true
type: string
- description: 员工职位
in: formData
name: position
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{"code": 200, "data":{}, "msg":"ok"}'
schema:
type: string
summary: 新增员工
tags:
- employees
/admin/v1/employees/{id}:
get:
consumes:
- application/json
parameters:
- description: auth by /admin/login
in: header
name: Authorization
required: true
type: string
- description: ID
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: '{"code": 200, "data": {}, "msg": "ok"}'
schema:
type: string
summary: 获取单个员工
tags:
- employees
put:
consumes:
- multipart/form-data
parameters:
- description: auth by /admin/login
in: header
name: Authorization
required: true
type: string
- description: ID
in: path
name: id
required: true
type: integer
- description: 员工用户名
in: formData
name: username
type: string
- description: 员工密码
in: formData
name: password
type: string
- description: 员工部门
in: formData
name: department
type: string
- description: 员工职位
in: formData
name: position
type: string
- description: 员工状态
in: formData
name: state
type: string
produces:
- application/json
responses:
"200":
description: '{"code": 200, "data":{}, "msg":"ok"}'
schema:
type: string
summary: 更新员工
tags:
- employees
swagger: "2.0"