接口文档.md
4.7 KB
一、点赞
请求路径
{host}/article/like
请求方法
POST
请求参数
名称 | 类型 | 描述 | 备注 |
---|---|---|---|
artId | string | 活动ID | |
article | string | 文章ID |
Request (JSON)
{
"actId": 1,
"articleId": 1
}
Result
{
"code": 200,
"message": "操作成功"
}
二、发送验证码
请求路径
{host}/passport/sms/sendCOde
请求方法
POST
请求参数
名称 | 类型 | 描述 | 备注 |
---|---|---|---|
mobile | string | 手机号 | |
area | string | 区域码 | 默认:86 |
应答参数
名称 | 描述 |
---|---|
name | 用户昵称 |
avatar | 头像 |
mobile | 手机号 |
Request (JSON)
{
"mobile": 18551982891
}
Result
{
"code": 200,
"message": "验证码发送成功"
}
三、验证并返回用户信息
请求路径
{host}/passport/sms/checkCode
请求方法
POST
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
mobile | string | 是 | 手机号 |
code | string | 是 | 验证码 |
应答参数
名称 | 描述 |
---|---|
name | 用户昵称 |
avatar | 头像 |
mobile | 手机号 |
Request (JSON)
{
"mobile": 18551933891
"code":1132
}
Result
{
"code": 200,
"data": {
"name": "用户_933891",
"avatar": "http://img12.static.yhbimg.com/imserver/2016/11/17/11/02bc3c3de856432175c01d937342a1f2ce.jpg",
"mobile": "18551933891"
},
"message": "获取用户信息成功"
}
四、文章列表
请求路径
{host}/article/list
请求方法
GET
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
actId | string | 是 | 活动ID |
pageNo | string | 否 | 页码 |
pageSize | string | 否 | 每页条数 |
orderBy | string | 否 | 排序字段名 |
order | string | 否 | 排序方向,asc或desc、不传则默认desc |
应答参数
名称 | 描述 |
---|---|
id | 文章ID |
goodCount | 点赞数 |
imgUrl | 图片url |
userName | 用户昵称 |
content | 文章内容 |
createTime | 文章创建时间 |
createTime | 文章创建时间 |
totalCount | 文章总数 |
totalPage | 文章总页数 |
Request(URL)
?actId=1
Result
{
"code": 200,
"data": [
{
id: 27,
goodCount: 0,
imgUrl: "http://img12.static.yhbimg.com/imserver/2016/11/17/11/02bc3c3de856432175c01d937342a1f2ce.jpg",
content: "测试文章内容22222222",
createTime: "2017-07-04T07:08:33.000Z",
userName: "185****2891"
}
...
...
],
"pageNo": 1,
"pageSize": 10,
"totalCount": 21,
"totalPage": 3,
"message": "获取成功"
}
五、发布文章
请求路径
{host}/article/publish
请求方法
POST
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
actId | string | 是 | 活动Id |
imgUrl | string | 是 | 图片链接 |
content | string | 是 | 内容 |
应答参数
名称 | 描述 |
---|---|
id | 文章ID |
Request (JSON)
{
"actId": 1
"imgUrl": 'http://img12.static.yhbimg.com/imserver/2016/11/17/11/02bc3c3de856432175c01d937342a1f2ce.jpg'
"content":'测试评论内容'
}
Result
{
"code": 200,
"data": {
id: 3
},
"message": "操作成功"
}
六、图片详情
请求路径
{host}/article/querySingle
请求方法
GET
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
actId | string | 是 | 活动Id |
articleId | string | 是 | 文章Id |
应答参数
名称 | 描述 |
---|---|
id | 文章ID |
content | 文章内容 |
goodCount | 点赞数 |
imgUrl | 图片地址 |
createTime | 创建时间 |
Request (URL)
?actId=1&articleId=1
Result
{
"code": 200,
"data": [
{
"id": 1,
"content": "减肥的萨克雷;放假啊到路口;非金属矿了;法电视剧付款啦第三节课了scriptalert('aaa')/script",
"goodCount": 0,
"createTime": "2017-07-04T07:08:33.000Z",
"imgUrl": "http://img01.yohoboys.com/o_1bk3gc79c11p21c4l1e4ksk0vdl7.jpg?imageMogr2/auto-orient/thumbnail/626/strip/gravity/Center/quality/60/crop/626x530/format/jpg"
}
],
"message": "获取成功"
}