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

最新推荐文章于 2022-03-06 01:13:01 发布
最新推荐文章于 2022-03-06 01:13:01 发布
阅读量2k 收藏 9
点赞数 2
分类专栏： vuejs 文章标签： vue.js
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/itwangyang520/article/details/108967730
版权

今日头条发发布管理系统

门户

查询所有已实现接口

基本信息

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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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

参数名称是否必须示例备注
challenge是GeeTest API2 参数
validate是GeeTest API2 参数
seccode是GeeTest 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
draft否true 或 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer 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是
Authorization是Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

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

Query

参数名称是否必须示例备注
draft否true 或 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是
Authorization是Bearer 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_pubdate否2019-01-01起始时间，不传就不限定开始时间
end_pubdate否2019-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是
Authorization是Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
collect否true 或 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是
Authorization是Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
type是a 或 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是
Authorization是Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

路径参数

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

Query

参数名称是否必须示例备注
begin_pubdate否2019-01-01起始时间
end_pubdate否2019-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是
Authorization是Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU用户 token

Query

参数名称是否必须示例备注
channel_id否频道 id，不传为全部
begin_pubdate否2019-01-01起始时间
end_pubdate否2019-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是
Authorization是Bearer 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

itwangyang520
关注
  • 2
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
今日头条接口
daimengs的博客
01-19 3万+
推荐:http://ic.snssdk.com/2/article/v25/stream/?count=20&min_behot_time=1504621638&bd_latitude=4.9E-324&bd_longitude=4.9E-324&bd_loc_time=1504622133&loc_mode=5&loc_time=1504564532&latitude=35.00125&long
今日头条、UC头条(大鱼号)、企鹅号文章分类、推送、拉取业务实现及接口api说明文档
weixin_45692202的博客
11-22 3621
简要描述： 基于今日头条、UC头条、企鹅号文章等(后续会继续增加接入平台)提供的文章，通过web服务接口，采集临时存储至服务器，服务器对数据进行分类、筛选后进行分发，目前只提供主要接口请求，主动推送功能未实现。获取新闻列表接口文档说明如下（更多详细说明请访问：http://showdoc.dagoogle.cn/index.php/home/item/show?item_id=63） 请求URL...
今日头条DMP平台API介绍.pdf
09-20
今日头条DMP平台API介绍.pdf
今日头条广告_API对接文档学习-1
纵横的博客
04-28 8586
1，概述 激活数，注册数和付费数是APP广告主衡量转化效果的一些重要指标。本文档主要主要用于满足头条广告主对广告效果的监测需求。把从头条广告渠道分发的APP激活数，注册数或者付费数回传给头条广告平台，帮助广告主跟踪广告的转化效果。 2，事件的定义 （1）广告点击：头条用户点击广告素材（进入落地页之后的点击不算数） （2）应用激活：当用户从头条客户端点击应用广告，并安装应用并首次打开（指的是今日头条...
vue前后端分离后台管理系统（权限管理，登录），前端脚手架。对接后端基于SpringSecurity提供的后台接口
m0_67402774的博客
03-06 1324
文章目录 前言(很重要哦) 一、概念和技术总结(重点，一定要搞懂) 1. vue 2. vue-admin-template模板文件解析 3. 异步相关，前后端交互 4. 导航守卫 5. 路由解析 二、单点登录实现 1. 后端接口和响应结果分析 2. 解决跨域，以及请求头.几乎所有项目都需要的配置，背下来吧。 3. 验证码展示 4. 单点登录，退出登录，根据后端API实现 1. api接口 2. 路由组件编写登录函数逻辑 3. 修改store（vuex）异步逻辑 5. 流程总结 三
renren.zip_diseaseiwf_renren-_vue_前后端分离_管理系统前端
09-23
标题中的"renren.zip_diseaseiwf_renren-_vue_前后端分离_管理系统前端"表明这是一个关于人人网(diseaseiwf可能是一个错误拼写，应该是"renren")的项目，使用了Vue.js技术实现前后端分离的管理系统前端。这个项目...
mall-admin-web是一个电商后台管理系统的前端项目，基于Vue+Element实现
04-19
mall-admin-web是一个电商后台管理系统的前端项目，基于Vue+Element实现。 主要包括商品管理、订单管理、会员管理、促销管理、运营管理、内容管理、统计报表、财务管理、权限管理、设置等功能。
vue-ydui使用文档
01-11
Vue-YDUI是一款基于Vue.js开发的前端组件库，它为开发者提供了丰富的UI组件，用于构建现代化的Web应用。在 Vue 开发过程中，Vue-YDUI 可以极大地提高开发效率，提供统一的界面风格和交互体验。由于官方文档无法访问...
前后端分离vue前端项目---员工管理系统（vue+springboot+redis）
06-28
vue前端项目---员工管理系统 前端技术栈：ES6、vue、vuex、vue-router、vue-cli、axios、element-ui 后端技术栈：SpringBoot、MyBatis、Spring Security、Jwt 系统划分了超级管理员、HR人事、经理与普通员工四大角色...
vue3-element-admin：vue3 + element-plus + typescript 后台管理系统
最新发布
05-04
vue3-element-admin 是【有来开源组织】基于 Vue3 + Vite4 + TypeScript + Element-Plus + Pinia 等前端主流技术栈从0到1搭建后台管理系统模板（前后端开源）。 后端是基于 Spring Boot 3.0 、Spring Security 6.0 ...
黑马头条前台API 接口文档
10-30
黑马头条前台-API 接口文档：用户登录，注册，编辑关注取消，评论；新闻文章：搜索，推荐，详情，列表获取，发布，收藏，点赞，编辑，文件上传；首页栏目获取和添加
今日头条对接新闻
01-23
用于对接今日头条发布新闻接口，.net版本（4.5.2） 使用注意：自己要到今日头条的管理中心配置数据 https://open.mp.toutiao.com/#/resource?_k=2o14u3 ，然后网站配置文件配置对接数据（详细看ToutiaoApi下的Config.cs）
接口文档示例.docx
08-13
开发文档模版，便于后台技术开发人员与前端开发人员的交流
今日头条移动 APP 广告应用下载数据 API 对
10-27
激活数、注册数和付费数是 APP 广告主衡量转化效果的一些重要指标，为满⾜今 ⽇头条（以下简称头条）广告主 对广告效果的监测需求，本文档介绍如何把从 头条广告渠道分发的 APP 激活数、注册数或付费数回传给头条广告平台，帮助广 告主跟踪转化效果。对于回调了激活、注册或付费数据的广告计划，头条支持 OCPC（目标激活成本出价、目标注册成本出价和目标付费成本出价）竞价方式， 帮助优化转化。回调方案适用于 Android 和 iOS。
今日头条&抖音小程序开发文档
热门推荐
初心 - 杨瑞超个人博客
02-13 2万+
初心-杨瑞超个人博客诚邀您加入qq群(IT-程序猿-技术交流群): 757345416丨(IT-程序猿-技术交流2群): 936929828 问题：百度上直接搜索“ 今日头条小程序开发文档 ” 或 “ 抖音小程序开发文档 ”，是搜不出来开发文档的，你可以搜索 “ 字节跳动小程序 ”。 点击这里可直接进入开发文档，或直接点击：https://developer.toutiao.com/docs/...
公众号头条文章数据接口 API 简介与使用场景、调用方法
DevOpenClub 专栏
01-10 3126
这次，再次给大家提供了一个公众号头条文章数据的 API，供大家调用、测试、开发自己的 App 使用。 之前在社区给大家免费开放了以下数据接口无限制的调用权限： 这次，再次给大家提供了一个公众号头条文章数据的 API，供大家调用、测试、开发自己的 App 使用。 1. 产品功能 此次开放了提供日更新的公众号头条文章在线接口，用于获取每日最热门的公众号文章数据。 提供公众号头条文章数据； 每...
显示来访用户的IP及其地区
weixin_34402408的博客
02-28 334
获取代码：把下面一小段代码加到你的主页中即可在您的网页上中显示来访用户的IP及其地区！ <script type="text/javascript" src="http://ip.chinaz.com/getip.aspx"></script> 您来自：218.29.6.165所在区域：河南省南阳市 联通 转载于:https://www.cnblogs.com/bi...
前端学习（3098）：vue+element今日头条管理-关于富文本编辑器
歌谣的博客
07-03 286
今日头条API
qq_29828155的博客
03-18 1万+
&lt;ul id="getnownew"&gt;&lt;/ul&gt; $(document).ready(function(){ $.ajax({ url: "http://ic.snssdk.com/2/article/v25/stream/?category=news_hot&amp;count=20&amp;min_behot_time=1457659116&...
iview-admin2.3.0 技术文档.docx
07-10
iview-admin 2.3.0 技术文档是一份详细说明如何使用和开发iview-admin框架的文档。该文档主要包含以下内容： 一、vue基础配置 在根目录下的vue.config.js文件中，可以找到以下代码： const BASE_URL = process.env....

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值