IconCreated with Sketch.

YAPI 接口文档
YApi

极客园PC

文章管理

删除文章

基本信息

Path： /v1_0/mp/articles/:target

Method： DELETE

接口描述：

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





特别注意： 不允许直接删除 已正式发表的文章，如想删除，需要先编辑，将其变为待审核或者草稿才可以删除

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是 用户token

路径参数

参数名称 示例 备注
target

Query

参数名称 是否必须 示例 备注
draft 否 true 是否存为草稿，true是 false否

Body

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

返回数据

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

发表文章

基本信息

Path： /v1_0/mp/articles

Method： POST

接口描述：

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

请求参数cover 中 传递样例为   { type: 0, images: []  }（无图） { type: 1, images: [“地址1”]  }（单图）  { type: 3, images: [“地址1”，‘地址2’，‘地址3’]  }
特别注意：  如果发表为正式文章，文章的状态会首先变为 待审核状态，即status为1,1分钟后系统会自动审核通过，状态成为审核通过，status为2，审核失败状态一般不存在

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是 用户token

Query

参数名称 是否必须 示例 备注
draft 否 true 是否存为草稿，true是 false否

Body

名称类型是否必须默认值备注其他信息
titlestring必须文章标题
contentstring必须文章内容
coverobject必须
├─ typestring必须封面类型 -1:自动，0-无图，1-1张，3-3张
├─ imagesstring必须item 类型: string
channel_idnumber必须文章所属频道id

返回数据

名称类型是否必须默认值备注其他信息
dataobject必须
├─ idstring必须文章id
messagestring必须

编辑文章

基本信息

Path： /v1_0/mp/articles/:target

Method： PUT

接口描述：

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

请求参数cover 中 传递样例为   { type: 0, images: []  }（无图） { type: 1, images: [“地址1”]  }（单图）  { type: 3, images: [“地址1”，‘地址2’，‘地址3’]  }

特别注意：  如果发表为正式文章，文章的状态会首先变为 待审核状态，即status为1,1分钟后系统会自动审核通过，状态成为审核通过，status为2，审核失败状态一般不存在

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是 用户token

路径参数

参数名称 示例 备注
target

Query

参数名称 是否必须 示例 备注
draft 否 true 是否存为草稿，true是 false否

Body

名称类型是否必须默认值备注其他信息
titlestring必须文章标题
contentstring必须文章内容
coverobject必须
├─ typestring必须封面类型 -1:自动，0-无图，1-1张，3-3张
├─ imagesstring必须item 类型: string
channel_idnumber必须文章所属频道id

返回数据

名称类型是否必须默认值备注其他信息
dataobject必须
├─ idstring必须文章id
messagestring必须

获取文章列表

基本信息

Path： /v1_0/mp/articles

Method： GET

接口描述：

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

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authorization 是 用户令牌 token

Query

参数名称 是否必须 示例 备注
status 否 文章状态，0-草稿，1-待审核，2-审核通过，3-审核失败，不传为全部
channel_id 是 不传为全部
begin_pubdate 否 起始时间
end_pubdate 否 截止时间
page 否 页码 默认为1页
per_page 否 每页数量 不传为默认10

返回数据

名称类型是否必须默认值备注其他信息
dataobject必须
├─ pageinteger必须当前页数
├─ per_pageinteger必须每页数量
├─ resultsobject []必须

item 类型: object

├─ idstring必须文章id
├─ titlestring必须文章标题
├─ statusstring必须文章状态
├─ comment_countstring必须评论数量
├─ pubdatestring必须发布时间
├─ coverobject必须封面
├─ typestring必须封面类型，0-无封面，1-1张封面图片，3-3张封面
├─ imagesstring必须封面图片
├─ like_countinteger必须点赞数
├─ read_countstring必须阅读数
├─ total_countinteger必须文章总数
messagestring必须

获取文章详情

基本信息

Path： /v1_0/mp/articles/:target

Method： GET

接口描述：

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

请求参数cover 中 传递样例为   { type: 0, images: []  }（无图） { type: 1, images: [“地址1”]  }（单图）  { type: 3, images: [“地址1”，‘地址2’，‘地址3’]  }
特别注意：  如果发表为正式文章，文章的状态会首先变为 待审核状态，即status为1,1分钟后系统会自动审核通过，状态成为审核通过，status为2，审核失败状态一般不存在

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是 用户token

路径参数

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

Body

名称类型是否必须默认值备注其他信息
titlestring必须文章标题
contentstring必须文章内容
coverobject必须
├─ typestring必须封面类型 -1:自动，0-无图，1-1张，3-3张
├─ imagesstring必须item 类型: string
channel_idnumber必须文章所属频道id

返回数据

名称类型是否必须默认值备注其他信息
dataobject必须
├─ idstring必须文章id
├─ titlestring必须标题
├─ channel_idstring必须频道id
├─ contentstring必须文章内容
├─ coverobject必须封面
├─ typenumber必须封面类型 0-无图，1-单图，3-三图
├─ imagesstring []必须封面图片地址数组

item 类型: string

├─ 非必须
messagestring必须

用户

发送短信验证码

基本信息

Path： /v1_0/sms/codes/:mobile

Method： GET

接口描述：

1 线上接口路径
http://localhost:8000/v1_0/sms/codes/:mobile

2 接口访问次数受限

每手机号每分钟1次

3 返回HTTP状态码

  1. 200 OK
  2. 404 手机号不正确
  3. 429 接口访问次数受限 ， body数据返回
{
   "message": "Too many requests."
}
  1. 507 服务器数据库异常

请求参数

路径参数

参数名称 示例 备注
mobile 18612345678 手机号

返回数据

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

用户认证（登录注册）

基本信息

Path： /v1_0/authorizations

Method： POST

接口描述：

1. 线上地址
http://localhost:8000/v1_0/authorizations

2.  返回HTTP状态码

1. 201 OK
2. 400 请求参数错误
        包括：参数缺失、手机号格式不正确、验证码失效等
3. 507 服务器数据库异常

3. token说明

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

请求参数

Headers

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

Body

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

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须提示信息
dataobject必须
├─ tokenstring必须用户token令牌
├─ refresh_tokenstring必须用于刷新token的令牌

编辑用户个人资料

基本信息

Path： /v1_0/user/profile

Method： PATCH

接口描述：

1 线上地址

http://localhost:8000/v1_0/user/profile

2 返回状态码

3 请求的字段参数 发送几个保存几个，不发送的不修改

请求参数

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU 用户令牌token

Body

名称类型是否必须默认值备注其他信息
namestring必须昵称
genderstring必须性别，0-男，1-女
birthdaystring必须生日，格式'2018-12-20'
real_namestring必须真实姓名
introstring必须个人介绍

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须提示信息
dataobject必须
├─ idstring必须用户id
├─ namestring必须用户名
├─ photostring必须头像url地址
├─ genderstring必须性别，0-男，1-女
├─ birthdaystring必须生日，格式 '2018-12-20'
├─ real_namestring必须真实用户名
├─ introstring必须个人介绍

编辑用户照片资料（头像、身份证照片）

基本信息

Path： /v1_0/user/photo

Method： PATCH

接口描述：

http://localhost:8000/v1_0/user/photo

2 返回状态码

3 请求的字段参数 发送几个保存几个，不发送的不修改

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type multipart/form-data 是
Authorization 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU 用户令牌token

Body

参数名称 参数类型 是否必须 示例 备注
photo file 否 头像

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须提示信息
dataobject必须
├─ idstring必须用户id
├─ photostring必须头像url地址

获取用户个人资料

基本信息

Path： /v1_0/user/profile

Method： GET

接口描述：

http://localhost:8000/v1_0/user/profile

2 返回状态码

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authorization 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU 用户令牌token

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须提示信息
dataobject必须
├─ idstring必须用户id
├─ namestring必须用户名
├─ photostring必须头像
├─ mobilestring必须手机号
├─ genderstring必须性别，0-男，1-女
├─ birthdaystring必须生日，格式 '2018-12-20'

获取用户的关注列表

基本信息

Path： /v1_0/user/followings

Method： GET

接口描述：

1 线上地址

http://localhost:8000/v1_0/user/followings

2 返回状态码

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authorization 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU 用户令牌token

Query

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

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须
dataobject必须
├─ total_countstring必须所有关注的用户总数
├─ pagestring必须当前页数
├─ per_pagestring必须每页数量
├─ resultsobject []必须

item 类型: object

├─ idstring必须关注的用户id
├─ namestring必须关注的用户名
├─ photostring必须头像
├─ fans_countstring必须粉丝数
├─ mutual_followstring必须是否互相关注

获取用户的粉丝列表

基本信息

Path： /v1_0/user/followers

Method： GET

接口描述：

1 线上地址

http://localhost:8000/v1_0/user/followings

2 返回状态码

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authorization 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU 用户令牌token

Query

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

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须
dataobject必须
├─ total_countstring必须所有关注的用户总数
├─ pagestring必须当前页数
├─ per_pagestring必须每页数量
├─ resultsobject []必须

item 类型: object

├─ idstring必须关注的用户id
├─ namestring必须关注的用户名
├─ photostring必须头像
├─ fans_countstring必须粉丝数
├─ mutual_followstring必须是否互相关注

获取用户自己信息

基本信息

Path： /v1_0/user

Method： GET

接口描述：

1 线上地址

http://localhost:8000/v1_0/user

2 返回状态码

3 强制用户登录

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authorization 是 Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NDMyODQzNjYsInVzZXJfaWQiOjF9.mLYitrKsn4E4KdQd0CNPugKrH8uQmXEQTlG_JutC8jU 用户令牌token，必传

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须提示信息
dataobject必须
├─ idstring必须用户id
├─ namestring必须用户名
├─ photostring必须用户头像
├─ is_mediastring必须是否是自媒体，0-否，1-是
├─ introstring必须简介
├─ certistring必须自媒体认证说明
├─ art_countstring必须发布文章数
├─ follow_countstring必须关注的数目
├─ fans_countstring必须fans_count
├─ like_countstring必须被点赞数

频道

获取所有频道列表

基本信息

Path： /v1_0/channels

Method： GET

接口描述：

http://localhost:8000/v1_0/channels

2 返回状态码

请求参数

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须提示信息
dataobject必须
├─ channelsobject []必须选项词条

item 类型: object

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

评论

获取评论或评论回复

基本信息

Path： /v1_0/comments

Method： GET

接口描述：

http://localhost:8000/v1_0/comments

2 返回状态码

请求参数

Query

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

返回数据

名称类型是否必须默认值备注其他信息
messagestring必须提示信息
dataobject必须
├─ total_countinteger必须该文章的评论总数 或 该评论的回复总数
├─ end_idstring必须所有评论或回复的最后一个id（截止offset值，小于此值的offset可以不用发送请求获取评论数据，已经没有数据），若无评论或回复数据，则值为NULL
├─ last_idstring必须本次返回结果的最后一个评论id，作为请求下一页数据的offset参数，若本次无具体数据，则值为NULL
├─ resultsobject []必须评论或回复的内容

item 类型: object

├─ com_idstring必须评论或回复id
├─ aut_idstring必须评论或回复的用户id
├─ aut_namestring必须用户名称
├─ aut_photostring必须用户头像url
├─ like_countinteger必须点赞数量
├─ reply_countinteger必须回复数量
├─ pubdatestring必须创建时间
├─ contentstring必须评论或回复内容
├─ is_likingboolean必须当前用户是否点赞

文件

上传图片

基本信息

Path： /v1_0/upload

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type multipart/form-data 是

Body

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

返回数据

名称类型是否必须默认值备注其他信息
dataobject必须
├─ urlstring必须上传成功的图片