黑马头条-自媒体

门户

查询所有已实现接口

基本信息

Path： /mp/

Method： GET

接口描述：

 

{
    "user.Authorization": "/v1_0/authorizations",
    "user.Captcha": "/v1_0/captchas/<mobile:mobile>",
    "user.SMSVerificationCode": "/v1_0/sms/codes/<mobile:mobile>"
}

键为接口名称
值为接口路径

请求参数

返回数据

名称

类型

是否必须

默认值

备注

其他信息

用户

刷新用户token

基本信息

Path： /mp/v1_0/authorizations

Method： PUT

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/authorizations

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
3.  403 refresh_token未携带或已过期
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

refresh_token

Body

名称

类型

是否必须

默认值

备注

其他信息

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ token

string

必须

用户token令牌

用户认证（登录）

基本信息

Path： /mp/v1_0/authorizations

Method： POST

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/authorizations

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
        包括：参数缺失、手机号格式不正确、验证码失效等
3.  403 用户非实名认证用户，无权限登录
4. 507 服务器数据库异常

3. token说明

  1. token用于访问需要身份认证的普通接口，有效期2小时
  2. refresh_token 用于在token过期后，获取新的用户token，有效期14天

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Body

名称

类型

是否必须

默认值

备注

其他信息

mobile

string

必须

手机号

code

string

必须

验证码

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ token

string

必须

用户token令牌

├─ refresh_token

string

必须

用于刷新token的令牌

├─ id

integer

必须

用户id

├─ name

string

必须

用户昵称

├─ photo

string

必须

用户头像

编辑用户头像

基本信息

Path： /mp/v1_0/user/photo

Method： PATCH

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/user/photo

2.  返回HTTP状态码

1. 200 OK
3. 401 token过期或未传
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

multipart/form-data

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

refresh_token

Body

参数名称

参数类型

是否必须

示例

备注

photo

file

否

头像图片

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ id

integer

必须

用户id

├─ photo

string

非必须

头像url地址

编辑用户资料

基本信息

Path： /mp/v1_0/user/profile

Method： PATCH

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/user/profile

2.  返回HTTP状态码

1. 201 OK
3. 401 token过期或未传
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

refresh_token

Body

名称

类型

是否必须

默认值

备注

其他信息

name

string

非必须

用户名

intro

string

非必须

头条号简介

email

string

非必须

邮箱

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ id

integer

必须

用户id

├─ name

string

非必须

用户名

├─ intro

string

非必须

头条号简介

├─ email

string

非必须

邮箱

获取人机验证码（极验 API1）

<a id=获取人机验证码（极验 API1）>

基本信息

Path： /mp/v1_0/captchas/:mobile

Method： GET

接口描述：

1 线上接口路径
http://ttapi.research.itcast.cn/mp/v1_0/captchas/:mobile
2 返回HTTP状态码
  1. 200 OK
  2. 404 手机号不正确
  3. 507 服务器数据库异常
3 返回值
{
    "message": "OK",
    "data": {
        "success": 1,
        "gt": "f00de9ed073bd781c94509932a309159",
        "challenge": "e902f4f9b8b4e63dda3db1ae12ad018c",
        "new_captcha": true
    }
}

请求参数

路径参数

参数名称

示例

备注

mobile

手机号

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

必须

├─ success

integer

必须

GeeTest返回值

├─ gt

string

必须

GeeTest返回值

├─ challenge

string

必须

GeeTest返回值

├─ new_captcha

boolean

必须

GeeTest返回值

获取用户个人资料

基本信息

Path： /mp/v1_0/user/profile

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/user/profile

2.  返回HTTP状态码

1. 201 OK
3. 401 token过期或未传
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

refresh_token

Body

名称

类型

是否必须

默认值

备注

其他信息

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ id

integer

必须

用户id

├─ name

string

必须

用户名

├─ intro

string

必须

头条号简介

├─ photo

string

必须

用户头像

├─ email

string

必须

邮箱

├─ mobile

string

必须

手机号

获取短信验证码 (极验 API2）

<a id=获取短信验证码 (极验 API2）>

基本信息

Path： /mp/v1_0/sms/codes/:mobile

Method： GET

接口描述：

1 线上接口路径
http://ttapi.research.itcast.cn/mp/v1_0/sms/codes/:mobile
2 返回HTTP状态码
  1. 200 OK
  2. 404 手机号不正确
  3. 400 本次验证极验GeeTest 已失效
  4. 403 极验验证失败
  5. 507 服务器数据库异常

请求参数

路径参数

参数名称

示例

备注

mobile

手机号

Query

参数名称

是否必须

示例

备注

challenge

是

GeeTest API2 参数

validate

是

GeeTest API2 参数

seccode

是

GeeTest API2 参数

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ mobile

string

必须

发送短信的手机号

获取粉丝列表

基本信息

Path： /mp/v1_0/followers

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/followers

2.  返回HTTP状态码

1. 200 OK
3. 401 token过期或未传
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

refresh_token

Query

参数名称

是否必须

示例

备注

page

否

页数

per_page

否

每页数量

Body

名称

类型

是否必须

默认值

备注

其他信息

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ total_count

integer

非必须

粉丝总数

├─ page

integer

非必须

当前页数

├─ per_page

integer

非必须

每页数量

├─ results

object []

非必须

item 类型: object

├─ id

integer

必须

粉丝id

├─ name

string

必须

粉丝用户名

├─ photo

string

必须

头像url

新闻

收藏图片素材

基本信息

Path： /mp/v1_0/user/images/:target

Method： PUT

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/user/images/:target

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

路径参数

参数名称

示例

备注

target

收藏的图片id

Body

名称

类型

是否必须

默认值

备注

其他信息

collect

boolean

必须

是否收藏，false-取消收藏，true-添加收藏

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ id

integer

必须

图片id

├─ collect

boolean

必须

是否收藏

上传用户图片素材

基本信息

Path： /mp/v1_0/user/images

Method： POST

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/user/images

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

multipart/form-data

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

Body

参数名称

参数类型

是否必须

示例

备注

image

file

是

图片

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ id

integer

必须

图片id

├─ url

string

必须

图片url

修改评论置顶

基本信息

Path： /mp/v1_0/comments/:target/sticky

Method： PUT

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/comments/:target/sticky

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 403 没有设置这条评论的权限
5. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

路径参数

参数名称

示例

备注

target

评论或回复id

Body

名称

类型

是否必须

默认值

备注

其他信息

sticky

boolean

必须

是否置顶

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ target

integer

必须

评论id

├─ sticky

boolean

必须

是否置顶

删除图片素材

基本信息

Path： /mp/v1_0/user/images/:target

Method： DELETE

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/user/images/:target

2.  返回HTTP状态码

1. 204  删除成功，没有message消息体数据
2.  401 token过期或未传
3. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

路径参数

参数名称

示例

备注

target

图片id

Body

名称

类型

是否必须

默认值

备注

其他信息

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

非必须

消息提示

删除文章

基本信息

Path： /mp/v1_0/articles/:target

Method： DELETE

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/articles/:target

2.  返回HTTP状态码

1. 204  删除成功，没有message消息体数据
2. 400 指定文章有误
3.  401 token过期或未传
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

路径参数

参数名称

示例

备注

target

文章id

Body

名称

类型

是否必须

默认值

备注

其他信息

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

非必须

消息提示

删除评论或回复

基本信息

Path： /mp/v1_0/comments/:target

Method： DELETE

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/comments/:target

2.  返回HTTP状态码

1. 204 OK
2. 403 没有删除这条评论的权限
3.  401 token过期或未传~~~~
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

路径参数

参数名称

示例

备注

target

评论或回复id

Body

名称

类型

是否必须

默认值

备注

其他信息

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

非必须

消息提示

发表文章（新建）

基本信息

Path： /mp/v1_0/articles

Method： POST

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/articles

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

Query

参数名称

是否必须

示例

备注

draft

否

true 或 false

是否存为草稿（true 为草稿）

Body

名称

类型

是否必须

默认值

备注

其他信息

title

string

必须

文章标题

content

string

必须

文章内容

cover

object

必须

封面

├─ type

integer

必须

封面类型 -1:自动，0-无图，1-1张，3-3张

├─ images

string []

必须

item 类型: string

channel_id

integer

必须

文章所属频道id

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ id

integer

必须

文章id

取消对评论或评论回复点赞

基本信息

Path： /mp/v1_0/comment/likings/:target

Method： DELETE

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/comment/likings/:target

2.  返回HTTP状态码

1. 204 OK
2.  401 token过期或未传~~~~
3. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

路径参数

参数名称

示例

备注

target

Body

名称

类型

是否必须

默认值

备注

其他信息

target

string

非必须

要取消点赞的评论id或评论回复id

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

非必须

消息提示

对评论或回复点赞

基本信息

Path： /mp/v1_0/comment/likings

Method： POST

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/comment/likings

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

Body

名称

类型

是否必须

默认值

备注

其他信息

target

integer

必须

点赞的评论id

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ target

integer

必须

评论id

修改文章评论状态

基本信息

Path： /mp/v1_0/comments/status

Method： PUT

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/comments/status?article_id=xxx

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

Query

参数名称

是否必须

示例

备注

article_id

是

文章id

Body

名称

类型

是否必须

默认值

备注

其他信息

allow_comment

boolean

必须

是否允许评论

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ article_id

integer

必须

文章id

├─ allow_comment

boolean

必须

是否允许评论

文章搜索

基本信息

Path： /mp/v1_0/search

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/search

2.  返回HTTP状态码

1. 200 OK
2. 400 请求参数错误
3. 401 token过期或未传~~~~
4. 507 服务器数据库异常

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

Query

参数名称

是否必须

示例

备注

q

是

检索关键词

page

否

页数

per_page

否

每页数量

Body

名称

类型

是否必须

默认值

备注

其他信息

mobile

string

必须

手机号

code

string

必须

验证码

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ total_count

integer

必须

文章总数

├─ page

integer

必须

当前页数

├─ per_page

integer

必须

每页数量

├─ results

object []

必须

文章列表

item 类型: object

├─ id

integer

必须

文章id

├─ title

string

必须

标题

├─ status

integer

必须

文章状态 0-草稿，1-待审核，2-审核通过，3-审核失败，4-已删除

├─ pubdate

string

必须

发布日期

├─ cover

object

必须

封面

├─ type

integer

必须

封面类型

├─ images

string []

必须

封面图片

item 类型: string

添加评论或评论回复

基本信息

Path： /mp/v1_0/comments

Method： POST

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/comments

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 403 文章已关闭评论
5. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

Body

名称

类型

是否必须

默认值

备注

其他信息

target

integer

必须

评论id

content

string

必须

评论回复内容

art_id

integer

必须

文章id

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ com_id

integer

必须

评论回复id

├─ target

integer

必须

评论所属的目标id

├─ art_id

integer

必须

评论所属的文章id

编辑文章（修改）

基本信息

Path： /mp/v1_0/articles/:target

Method： PUT

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/articles

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

路径参数

参数名称

示例

备注

target

文章id

Query

参数名称

是否必须

示例

备注

draft

否

true 或 false

是否存为草稿（true 为草稿）

Body

名称

类型

是否必须

默认值

备注

其他信息

title

string

必须

文章标题

content

string

必须

文章内容

cover

object

必须

封面

├─ type

integer

必须

封面类型 -1:自动，0-无图，1-1张，3-3张

├─ images

string []

必须

item 类型: string

channel_id

integer

必须

文章所属频道id

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ id

integer

必须

文章id

获取指定文章

基本信息

Path： /mp/v1_0/articles/:target

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/articles

2.  返回HTTP状态码

1. 200 OK
2. 401 token过期或未传~~~~
3. 507 服务器数据库异常

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

路径参数

参数名称

示例

备注

target

文章id

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

├─ id

integer

必须

文章id

├─ title

string

必须

标题

├─ channel_id

integer

必须

频道id

├─ content

string

必须

文章内容

├─ cover

object

必须

封面

├─ type

integer

必须

封面类型

├─ images

string []

必须

封面图片

item 类型: string

获取文章列表（适用内容管理、评论管理、图文数据）

基本信息

Path： /mp/v1_0/articles

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/articles

2.  返回HTTP状态码

1. 200 OK
2. 400 请求参数错误
3. 401 token过期或未传~~~~
4. 507 服务器数据库异常

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Query

参数名称

是否必须

示例

备注

status

否

文章状态，0-草稿，1-待审核，2-审核通过，3-审核失败，4-已删除，不传为全部

channel_id

否

频道id，不传为全部

begin_pubdate

否

2019-01-01

起始时间

end_pubdate

否

2019-01-02

截止时间

page

否

页数

per_page

否

每页数量

response_type

否

返回数据的字段，不传返回用于内容管理的字段，传comment 返回用于评论管理的字段，传statistic 返回用于图文数据的字段

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ total_count

integer

必须

文章总数

├─ page

integer

必须

当前页数

├─ per_page

integer

必须

每页数量

├─ results

object []

必须

文章列表

item 类型: object

├─ id

integer

必须

文章id

├─ title

string

必须

标题

├─ status

integer

非必须

文章状态 0-草稿，1-待审核，2-审核通过，3-审核失败，4-已删除

├─ pubdate

string

非必须

发布日期

├─ cover

object

非必须

封面

├─ type

integer

必须

封面类型

├─ images

string []

必须

封面图片

item 类型: string

├─ comment_status

boolean

非必须

评论状态，response_type=comment时返回

├─ total_comment_count

integer

非必须

总评论数，response_type=comment时返回

├─ fans_comment_count

integer

非必须

粉丝评论数，response_type=comment时返回

├─ comment_count

integer

非必须

评论数，response_type=statistic时返回

├─ read_count

integer

非必须

阅读数，response_type=statistic时返回

├─ like_count

integer

非必须

点赞数，response_type=statistic时返回

├─ repost_count

integer

非必须

转发数，response_type=statistic时返回

├─ collect_count

integer

非必须

收藏数，response_type=statistic时返回

获取文章频道

基本信息

Path： /mp/v1_0/channels

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/channels

2.  返回HTTP状态码

1. 200 OK
2. 507 服务器数据库异常

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ channels

object []

非必须

频道

item 类型: object

├─ id

integer

必须

频道id

├─ name

string

必须

频道名称

获取用户图片素材

基本信息

Path： /mp/v1_0/user/images

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/user/images

2.  返回HTTP状态码

1. 200 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

Query

参数名称

是否必须

示例

备注

collect

否

true 或 false

是否是收藏的图片

page

否

页数

per_page

否

每页数量

Body

名称

类型

是否必须

默认值

备注

其他信息

mobile

string

必须

手机号

code

string

必须

验证码

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ total_count

integer

必须

图片总数

├─ page

integer

必须

当前页数

├─ per_page

integer

必须

每页数量

├─ results

object []

必须

item 类型: object

├─ id

integer

必须

图片id

├─ url

string

必须

图片url

├─ is_collected

boolean

必须

是否收藏

获取评论或评论回复

基本信息

Path： /mp/v1_0/comments

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/comments

2.  返回HTTP状态码

1. 200 OK
2. 400 请求参数错误
3.  401 token过期或未传~~~~
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

Query

参数名称

是否必须

示例

备注

type

是

a或c

评论类型，a-对文章(article)的评论，c-对评论(comment)的回复

source

是

文章id 或 评论id

offset

否

获取评论数据的偏移量，值为评论id，表示从此id的数据向后取，不传表示从第一页开始读取数据

limit

否

获取的评论数据个数，不传表示采用后端服务设定的默认每页数据量

Body

名称

类型

是否必须

默认值

备注

其他信息

allow_comment

boolean

必须

是否允许评论

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

data

object

非必须

数据

├─ total_count

integer

必须

文章的评论总数 或 评论的总回复数

├─ art_id

integer

非必须

文章id，只在type=a时返回

├─ art_title

string

非必须

文章标题，只在type=a时返回

├─ art_pubdate

string

非必须

文章发布日期，只在type=a时返回

├─ end_id

integer

必须

所有评论或回复的最后一个id（截止offset值，小于此值的offset可以不用发送请求获取评论数据，已经没有数据），若无评论或回复数据，则值为NULL

├─ last_id

integer

必须

本次返回结果的最后一个评论id，作为请求下一页数据的offset参数，若本次无具体数据，则值为NULL

├─ results

object []

必须

评论或回复的内容

item 类型: object

├─ com_id

integer

必须

评论或回复id

├─ aut_id

integer

必须

评论或回复的用户id

├─ aut_name

string

必须

用户名称

├─ aut_photo

string

必须

用户头像url

├─ like_count

integer

必须

点赞数量

├─ reply_count

integer

必须

回复数量

├─ pubdate

string

必须

创建日期

├─ content

string

必须

评论或回复内容

├─ is_top

integer

必须

是否置顶，0-不置顶，1-置顶

├─ is_liking

integer

必须

是否点赞，0-未点赞，1-已点赞

统计

获取指定文章详细统计数据

基本信息

Path： /mp/v1_0/statistics/articles/:article_id

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/statistics/articles/:article_id

2.  返回HTTP状态码

1. 200 OK
2. 400 请求参数错误
3. 401 token过期或未传~~~~
4. 507 服务器数据库异常

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

路径参数

参数名称

示例

备注

article_id

文章id

Query

参数名称

是否必须

示例

备注

begin_pubdate

否

2019-01-01

起始时间

end_pubdate

否

2019-01-02

截止时间

Body

名称

类型

是否必须

默认值

备注

其他信息

mobile

string

必须

手机号

code

string

必须

验证码

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

OK

消息提示

枚举: OK

data

object

必须

数据

├─ avg_read_proc

number

必须

平均阅读进度

最大值: 1

最小值: 0

├─ bounce_rate

number

必须

跳出率

最大值: 1

最小值: 0

├─ time_spent

integer

必须

阅读时间，单位秒

最大值: 1000

最小值: 1

├─ conversion

object

必须

转化

├─ reco_count

integer

必须

推荐量

最大值: 10000

最小值: 0

├─ read_count

integer

必须

阅读量

最大值: 8000

最小值: 0

├─ fans_read_count

integer

必须

粉丝阅读量

最大值: 6000

最小值: 0

├─ comment_count

integer

必须

评论量

最大值: 7000

最小值: 0

├─ origin

object

必须

来源

├─ recommend

integer

必须

推荐

最大值: 10000

最小值: 0

├─ channel

integer

必须

频道

最大值: 10000

最小值: 0

├─ relation

integer

必须

相关

最大值: 10000

最小值: 0

├─ outter

integer

必须

应用外

最大值: 10000

最小值: 0

├─ other

integer

必须

其他

最大值: 10000

最小值: 0

├─ completed

object

必须

完成度

├─ gt80

integer

必须

超过80%

最大值: 10000

最小值: 0

├─ lt80

integer

必须

低于80%

最大值: 10000

最小值: 0

├─ lt20

integer

必须

低于20%

最大值: 10000

最小值: 0

获取文章统计数据（总量）

基本信息

Path： /mp/v1_0/statistics/articles

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/statistics/articles

2.  返回HTTP状态码

1. 200 OK
2. 400 请求参数错误
3. 401 token过期或未传~~~~
4. 507 服务器数据库异常

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

用户token

Query

参数名称

是否必须

示例

备注

channel_id

否

频道id，不传为全部

begin_pubdate

否

2019-01-01

起始时间

end_pubdate

否

2019-01-02

截止时间

Body

名称

类型

是否必须

默认值

备注

其他信息

mobile

string

必须

手机号

code

string

必须

验证码

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

OK

消息提示

枚举: OK

data

object

必须

数据

├─ read_count

integer

必须

阅读量

最大值: 10000

最小值: 0

├─ comment_count

integer

必须

评论量

最大值: 10000

最小值: 0

├─ collect_count

integer

必须

收藏量

最大值: 10000

最小值: 0

├─ repost_count

integer

必须

转发量

最大值: 10000

最小值: 0

获取粉丝统计数据

基本信息

Path： /mp/v1_0/statistics/followers

Method： GET

接口描述：

1. 线上地址
http://ttapi.research.itcast.cn/mp/v1_0/statistics/followers

2.  返回HTTP状态码

1. 200 OK
3. 401 token过期或未传
4. 507 服务器数据库异常

3. token说明

在Authorization 请求头中携带的token，格式为"Bearer "拼接上token，注意Bearer后有一个空格

请求参数

Headers

参数名称

参数值

是否必须

示例

备注

Content-Type

application/json

是

Authorization

是

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU

refresh_token

Body

名称

类型

是否必须

默认值

备注

其他信息

返回数据

名称

类型

是否必须

默认值

备注

其他信息

message

string

必须

消息提示

枚举: OK

data

object

必须

数据

├─ gender

object

必须

├─ male

integer

必须

男粉丝数量

最大值: 1000

最小值: 0

├─ female

integer

必须

女粉丝数量

最大值: 1000

最小值: 0

├─ age

object

必须

├─ le18

integer

必须

0-18

最大值: 300

最小值: 0

├─ le23

integer

必须

19-23

最大值: 300

最小值: 0

├─ le30

integer

必须

24-30

最大值: 300

最小值: 0

├─ le40

integer

必须

31-40

最大值: 300

最小值: 0

├─ le50

integer

必须

41-50

最大值: 300

最小值: 0

├─ gt50

integer

必须

50+

最大值: 300

最小值: 0

├─ device

object

必须

├─ ios

integer

必须

最大值: 1000

最小值: 0

├─ android

integer

必须

最大值: 1000

最小值: 0