You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
go-fly/docs/swagger.yaml

132 lines
2.8 KiB

basePath: '{{.BasePath}}'
definitions:
controller.Response:
properties:
code:
type: integer
msg:
type: string
result:
type: object
type: object
host: '{{.Host}}'
info:
contact: {}
description: '{{.Description}}'
license: {}
title: '{{.Title}}'
version: '{{.Version}}'
paths:
/check:
post:
consumes:
- multipart/form-data
parameters:
- description: 用户名
in: formData
name: username
required: true
type: string
- description: 密码
in: formData
name: password
required: true
type: string
- description: 类型
in: formData
name: type
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/controller.Response'
type: object
summary: 登陆验证接口
/message:
post:
consumes:
- multipart/form-data
parameters:
- description: 来源uid
in: formData
name: from_id
required: true
type: string
- description: 目标uid
in: formData
name: to_id
required: true
type: string
- description: 内容
in: formData
name: content
required: true
type: string
- description: 类型|kefu,visitor
in: formData
name: type
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/controller.Response'
type: object
summary: 发送消息接口
/messages:
get:
consumes:
- multipart/form-data
parameters:
- description: 访客ID
in: query
name: visitorId
required: true
type: string
- description: 认证token
in: header
name: token
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/controller.Response'
type: object
summary: 获取访客聊天信息接口
/visitors:
get:
consumes:
- multipart/form-data
parameters:
- description: 分页
in: query
name: page
required: true
type: string
- description: 认证token
in: header
name: token
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/controller.Response'
type: object
summary: 获取访客列表接口
swagger: "2.0"