dtcms 源码 分布式调度 微信小程序教程 高阶函数 bootstrap keras merge wso2 八大员 后台界面模板 jquery通过class获取元素 linux源码在线阅读 python3网络编程 python解析json数据 java环境安装 java游戏开发 ** pushstate emit qq免安装 abr文件 hyqihei 圆角矩形工具改变弧度 小程序游戏源码 lrc软件 流媒体下载 苹果手机常去地点 k3刷机 Linux进程查看 狂战传说套装选择 三菱plc序列号 汉仪黑荔枝体简 studio3t 安装telnet 电脑防护软件 autoit教程 磁盘碎片清理 sql四舍五入 闲鱼怎么加好友 雷达图怎么做
当前位置: 首页 > 学习教程  > 编程语言

2020-web前端-今日头条发布管理系统-使用vue来完成-接口文档-Day01

2020/10/8 20:17:05 文章标签:

今日头条发发布管理系统 门户 查询所有已实现接口 基本信息 Path: /mp/ Method: GET 接口描述: 线上接口地址 http://ttapi.research.itcast.cn/mp/ 返回已上线接口地址,形如: {"user.Authorization"…

今日头条发发布管理系统

门户

查询所有已实现接口

基本信息

Path: /mp/

Method: GET

接口描述:

线上接口地址 http://ttapi.research.itcast.cn/mp/
返回已上线接口地址,形如:

{
    "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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jUrefresh_token

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ tokenstring必须用户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天
请求方法:GET

请求参数(GET 方法就是 Query 参数,POST 方法就是 Body 参数):

{
  foo: 'bar'
}

请求参数

Headers

参数名称参数值是否必须示例备注
Content-Typeapplication/json

Body

名称类型是否必须默认值备注其他信息
mobilestring必须手机号
codestring必须验证码

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ tokenstring必须用户token令牌
├─ refresh_tokenstring必须用于刷新token的令牌
├─ idinteger必须用户id
├─ namestring必须用户昵称
├─ photostring必须用户头像

编辑用户头像

基本信息

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-Typemultipart/form-data
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jUrefresh_token

Body

参数名称参数类型是否必须示例备注
photofile头像图片

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ idinteger必须用户id
├─ photostring非必须头像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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jUrefresh_token

Body

名称类型是否必须默认值备注其他信息
namestring非必须用户名
introstring非必须头条号简介
emailstring非必须邮箱

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ idinteger必须用户id
├─ namestring非必须用户名
├─ introstring非必须头条号简介
├─ emailstring非必须邮箱

获取人机验证码(极验 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手机号

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject必须
├─ successinteger必须GeeTest返回值
├─ gtstring必须GeeTest返回值
├─ challengestring必须GeeTest返回值
├─ new_captchaboolean必须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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jUrefresh_token

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ idinteger必须用户id
├─ namestring必须用户名
├─ introstring必须头条号简介
├─ photostring必须用户头像
├─ emailstring必须邮箱
├─ mobilestring必须手机号

获取短信验证码 (极验 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

参数名称是否必须示例备注
challengeGeeTest API2 参数
validateGeeTest API2 参数
seccodeGeeTest API2 参数

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ mobilestring必须发送短信的手机号

获取粉丝列表

基本信息

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jUrefresh_token

Query

参数名称是否必须示例备注
page页数
per_page每页数量

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ total_countinteger非必须粉丝总数
├─ pageinteger非必须当前页数
├─ per_pageinteger非必须每页数量
├─ resultsobject []非必须

item 类型: object

├─ idinteger必须粉丝id
├─ namestring必须粉丝用户名
├─ photostring必须头像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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

参数名称示例备注
target收藏的图片 id

Body

名称类型是否必须默认值备注其他信息
collectboolean必须是否收藏,false-取消收藏,true-添加收藏

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ idinteger必须图片id
├─ collectboolean必须是否收藏

上传用户图片素材

基本信息

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-Typemultipart/form-data
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Body

参数名称参数类型是否必须示例备注
imagefile图片

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ idinteger必须图片id
├─ urlstring必须图片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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

参数名称示例备注
target评论或回复 id

Body

名称类型是否必须默认值备注其他信息
stickyboolean必须是否置顶

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ targetinteger必须评论id
├─ stickyboolean必须是否置顶

删除图片素材

基本信息

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

参数名称示例备注
target图片 id

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
messagestring非必须消息提示

删除文章

基本信息

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

参数名称示例备注
target文章 id

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
messagestring非必须消息提示

删除评论或回复

基本信息

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

参数名称示例备注
target评论或回复 id

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
messagestring非必须消息提示

发表文章(新建)

基本信息

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
drafttrue 或 false是否存为草稿(true 为草稿)

Body

名称类型是否必须默认值备注其他信息
titlestring必须文章标题
contentstring必须文章内容
coverobject必须封面
├─ typeinteger必须封面类型 -1:自动,0-无图,1-1张,3-3张
├─ imagesstring []必须

item 类型: string

channel_idinteger必须文章所属频道id

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ idinteger必须文章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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

参数名称示例备注
target

Body

名称类型是否必须默认值备注其他信息
targetstring非必须要取消点赞的评论id或评论回复id

返回数据

名称类型是否必须默认值备注其他信息
messagestring非必须消息提示

对评论或回复点赞

基本信息

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Body

名称类型是否必须默认值备注其他信息
targetinteger必须点赞的评论id

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ targetinteger必须评论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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
article_id文章 id

Body

名称类型是否必须默认值备注其他信息
allow_commentboolean必须是否允许评论

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ article_idinteger必须文章id
├─ allow_commentboolean必须是否允许评论

文章搜索

基本信息

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
q检索关键词
page页数
per_page每页数量

Body

名称类型是否必须默认值备注其他信息
mobilestring必须手机号
codestring必须验证码

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ total_countinteger必须文章总数
├─ pageinteger必须当前页数
├─ per_pageinteger必须每页数量
├─ resultsobject []必须文章列表

item 类型: object

├─ idinteger必须文章id
├─ titlestring必须标题
├─ statusinteger必须文章状态 0-草稿,1-待审核,2-审核通过,3-审核失败,4-已删除
├─ pubdatestring必须发布日期
├─ coverobject必须封面
├─ typeinteger必须封面类型
├─ imagesstring []必须封面图片

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Body

名称类型是否必须默认值备注其他信息
targetinteger必须评论id
contentstring必须评论回复内容
art_idinteger必须文章id

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ com_idinteger必须评论回复id
├─ targetinteger必须评论所属的目标id
├─ art_idinteger必须评论所属的文章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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

参数名称示例备注
target文章 id

Query

参数名称是否必须示例备注
drafttrue 或 false是否存为草稿(true 为草稿)

Body

名称类型是否必须默认值备注其他信息
titlestring必须文章标题
contentstring必须文章内容
coverobject必须封面
├─ typeinteger必须封面类型 -1:自动,0-无图,1-1张,3-3张
├─ imagesstring []必须

item 类型: string

channel_idinteger必须文章所属频道id

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ idinteger必须文章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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

参数名称示例备注
target文章 id

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须
├─ idinteger必须文章id
├─ titlestring必须标题
├─ channel_idinteger必须频道id
├─ contentstring必须文章内容
├─ coverobject必须封面
├─ typeinteger必须封面类型
├─ imagesstring []必须封面图片

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-Typeapplication/json

Query

参数名称是否必须示例备注
status文章状态,0-草稿,1-待审核,2-审核通过,3-审核失败,4-已删除,不传为全部
channel_id频道 id,不传为全部
begin_pubdate2019-01-01起始时间,不传就不限定开始时间
end_pubdate2019-01-02截止时间,不传就不限定结束时间
page页数,默认是 1
per_page每页数量,默认每页 10 条
response_type返回数据的字段,不传返回用于内容管理的字段,传 comment 返回用于评论管理的字段,传 statistic 返回用于图文数据的字段

Body

名称类型是否必须默认值备注其他信息
mobilestring必须手机号
codestring必须验证码

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ total_countinteger必须文章总数
├─ pageinteger必须当前页数
├─ per_pageinteger必须每页数量
├─ resultsobject []必须文章列表

item 类型: object

├─ idinteger必须文章id
├─ titlestring必须标题
├─ statusinteger非必须文章状态 0-草稿,1-待审核,2-审核通过,3-审核失败,4-已删除
├─ pubdatestring非必须发布日期
├─ coverobject非必须封面
├─ typeinteger必须封面类型
├─ imagesstring []必须封面图片

item 类型: string

├─ comment_statusboolean非必须评论状态,response_type=comment时返回
├─ total_comment_countinteger非必须总评论数,response_type=comment时返回
├─ fans_comment_countinteger非必须粉丝评论数,response_type=comment时返回
├─ comment_countinteger非必须评论数,response_type=statistic时返回
├─ read_countinteger非必须阅读数,response_type=statistic时返回
├─ like_countinteger非必须点赞数,response_type=statistic时返回
├─ repost_countinteger非必须转发数,response_type=statistic时返回
├─ collect_countinteger非必须收藏数,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-Typeapplication/json

Body

名称类型是否必须默认值备注其他信息
mobilestring必须手机号
codestring必须验证码

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ channelsobject []非必须频道

item 类型: object

├─ idinteger必须频道id
├─ namestring必须频道名称

获取用户图片素材

基本信息

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
collecttrue 或 false是否是收藏的图片
page页数
per_page每页数量

Body

名称类型是否必须默认值备注其他信息
mobilestring必须手机号
codestring必须验证码

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ total_countinteger必须图片总数
├─ pageinteger必须当前页数
├─ per_pageinteger必须每页数量
├─ resultsobject []必须

item 类型: object

├─ idinteger必须图片id
├─ urlstring必须图片url
├─ is_collectedboolean必须是否收藏

获取评论或评论回复

基本信息

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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
typea 或 c评论类型,a-对文章(article)的评论,c-对评论(comment)的回复
source文章 id 或 评论 id
offset获取评论数据的偏移量,值为评论 id,表示从此 id 的数据向后取,不传表示从第一页开始读取数据
limit获取的评论数据个数,不传表示采用后端服务设定的默认每页数据量

Body

名称类型是否必须默认值备注其他信息
allow_commentboolean必须是否允许评论

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示
dataobject非必须数据
├─ total_countinteger必须文章的评论总数 或 评论的总回复数
├─ art_idinteger非必须文章id,只在type=a时返回
├─ art_titlestring非必须文章标题,只在type=a时返回
├─ art_pubdatestring非必须文章发布日期,只在type=a时返回
├─ end_idinteger必须所有评论或回复的最后一个id(截止offset值,小于此值的offset可以不用发送请求获取评论数据,已经没有数据),若无评论或回复数据,则值为NULL
├─ last_idinteger必须本次返回结果的最后一个评论id,作为请求下一页数据的offset参数,若本次无具体数据,则值为NULL
├─ resultsobject []必须评论或回复的内容

item 类型: object

├─ com_idinteger必须评论或回复id
├─ aut_idinteger必须评论或回复的用户id
├─ aut_namestring必须用户名称
├─ aut_photostring必须用户头像url
├─ like_countinteger必须点赞数量
├─ reply_countinteger必须回复数量
├─ pubdatestring必须创建日期
├─ contentstring必须评论或回复内容
├─ is_topinteger必须是否置顶,0-不置顶,1-置顶
├─ is_likinginteger必须是否点赞,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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

参数名称示例备注
article_id文章 id

Query

参数名称是否必须示例备注
begin_pubdate2019-01-01起始时间
end_pubdate2019-01-02截止时间

Body

名称类型是否必须默认值备注其他信息
mobilestring必须手机号
codestring必须验证码

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须OK消息提示

枚举: OK

dataobject必须数据
├─ avg_read_procnumber必须平均阅读进度

最大值: 1

最小值: 0

├─ bounce_ratenumber必须跳出率

最大值: 1

最小值: 0

├─ time_spentinteger必须阅读时间,单位秒

最大值: 1000

最小值: 1

├─ conversionobject必须转化
├─ reco_countinteger必须推荐量

最大值: 10000

最小值: 0

├─ read_countinteger必须阅读量

最大值: 8000

最小值: 0

├─ fans_read_countinteger必须粉丝阅读量

最大值: 6000

最小值: 0

├─ comment_countinteger必须评论量

最大值: 7000

最小值: 0

├─ originobject必须来源
├─ recommendinteger必须推荐

最大值: 10000

最小值: 0

├─ channelinteger必须频道

最大值: 10000

最小值: 0

├─ relationinteger必须相关

最大值: 10000

最小值: 0

├─ outterinteger必须应用外

最大值: 10000

最小值: 0

├─ otherinteger必须其他

最大值: 10000

最小值: 0

├─ completedobject必须完成度
├─ gt80integer必须超过80%

最大值: 10000

最小值: 0

├─ lt80integer必须低于80%

最大值: 10000

最小值: 0

├─ lt20integer必须低于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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
channel_id频道 id,不传为全部
begin_pubdate2019-01-01起始时间
end_pubdate2019-01-02截止时间

Body

名称类型是否必须默认值备注其他信息
mobilestring必须手机号
codestring必须验证码

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须OK消息提示

枚举: OK

dataobject必须数据
├─ read_countinteger必须阅读量

最大值: 10000

最小值: 0

├─ comment_countinteger必须评论量

最大值: 10000

最小值: 0

├─ collect_countinteger必须收藏量

最大值: 10000

最小值: 0

├─ repost_countinteger必须转发量

最大值: 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-Typeapplication/json
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jUrefresh_token

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须消息提示

枚举: OK

dataobject必须数据
├─ genderobject必须
├─ maleinteger必须男粉丝数量

最大值: 1000

最小值: 0

├─ femaleinteger必须女粉丝数量

最大值: 1000

最小值: 0

├─ ageobject必须
├─ le18integer必须0-18

最大值: 300

最小值: 0

├─ le23integer必须19-23

最大值: 300

最小值: 0

├─ le30integer必须24-30

最大值: 300

最小值: 0

├─ le40integer必须31-40

最大值: 300

最小值: 0

├─ le50integer必须41-50

最大值: 300

最小值: 0

├─ gt50integer必须50+

最大值: 300

最小值: 0

├─ deviceobject必须
├─ iosinteger必须

最大值: 1000

最小值: 0

├─ androidinteger必须

最大值: 1000

最小值: 0


本文链接: http://www.dtmao.cc/news_show_250246.shtml

附件下载

相关教程

    暂无相关的数据...

共有条评论 网友评论

验证码: 看不清楚?