XFE 技术 生活 笔记 文集

博客第二版接口文档

🔖 技术 👀 72 🕒 2019-04-18 👨‍🎓 XFE/Peter

更新时间: 2018年12月17日11:57:00

基础说明

请求baseUrl

https://api.xc123.net

请求方式

统一使用 post 请求方式

用户Token 处理

在请求的基础工具函数中,统一将token放置在 Request Body 中携带,当后端有需求的时候回自动从 Request Body 中取以此完成token的自动处理。

在web端,将以cookie的形式处理,这个api端已经处理完毕

小程序端

let token = wx.getStorageSync('token');
wx.request({
url: `${baseUrls}${url}`,
method,
data: {
...params,
token: token
},

返回参数结构说明

{
code: 200
body:[]
message:'请求成功'
}

code

说明
200 请求处理成功
403 用户信息验证不通过
405 请求参数验证不通过
500 请求处理出错,或请求失败

body

说明
Object、Array 正常返回的数据类型,具体请见个接口文档
{} 单个数据空对象
[] 多个数据空数组

message

请求响应的消息

账户

用户对象说明

属性名 数据类型 说明
id Number 用户唯一标识
username String 用户名
password String 用户密码
nikename String 用户昵称
introduction String 用户简介
phone String 用户手机号
sex String 用户性别(0: 未知,1:女,2:男)

[x] 微信登录

请求地址

/wechat/login

请求参数

参数名 数据类型 说明 必传
nikename String 昵称
sex String 性别
code String wx.login 得到的 code

返回示例

{
code:200,
body:{
token:'xxxxxxx',
user:{
id:'110',
nikename:'隔壁老王',
sex:'1',
phone:'18888888888',
introduction:'这是文档说明中最牛逼的个人简介'
}
},
message:'登录成功'
}
{
code:405,
body:{},
message:'缺少参数 xxx'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 账号密码登录

请求地址

/user/login

请求参数

参数名 数据类型 说明 必传
username String 用户名
password String 密码

返回示例

{
code:200,
body:{
token:'xxxxxxx',
user:{
id:'110',
nikename:'隔壁老王',
sex:'1',
phone:'18888888888',
introduction:'这是文档说明中最牛逼的个人简介'
}
},
message:'登录成功'
}
{
code:405,
body:{},
message:'缺少参数 xxx'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 注册

请求地址

/user/regist

请求参数

参数名 数据类型 说明 必传
username String 用户名
password String 密码

返回示例

{
code:200,
body:{
token:'xxxxxxx',
user:{
id:'110',
nikename:'隔壁老王',
sex:'1',
phone:'18888888888',
introduction:'这是文档说明中最牛逼的个人简介'
}
},
message:'注册成功'
}
{
code:405,
body:{},
msg:'缺少参数 xxx'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 个人资料

请求地址

/user/detail

返回示例

{
code:200,
body:{
id:'110',
nikename:'隔壁老王',
sex:'1',
phone:'18888888888',
introduction:'这是文档说明中最牛逼的个人简介'
},
message:'请求成功'
}
{
code:403,
body:{},
msg:'您没有足够的权限'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 个人资料修改

请求地址

/user/update

请求参数

参数名 数据类型 说明 必传
nikename String 用户昵称
sex String 用户性别(0:女,1:男)
introduction String 用户简介
phone String 用户手机号

返回示例

{
code:200,
body:{},
message:'修改成功'
}
{
code:403,
body:{},
message:'您的没有足够的权限'
}
{
code:405,
body:{},
message:'缺少参数 xxx'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 密码修改

请求地址

/user/resetppassword

请求参数
|参数名| 数据类型| 说明|必传|
|:----:|:----:|:----:|:----:|
|username| String| 用户昵称|是|
|oldpwd| String| 老密码|是|
|newpwd| String| 新密码|是|

返回示例

{
code:200,
body:{},
message:'修改成功'
}
{
code:403,
body:{},
message:'您的没有足够的权限'
}
{
code:405,
body:{},
message:'缺少参数 xxx'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

文章

文章对象说明

属性名 数据类型 说明
id Number 文章唯一标识
title String 文章标题
user_id Number 用户唯一标识
author String 作者
content String 文章内容
updatetime String 文章更新时间
typename String 文章所属标签
description String 文章描述
visit Number 文章访问次数
visitor Array 文章历史访问者

文章列表分类参数说明

分类值 说明
1 技术文章
2 笔记
3 生活文章
4 文集文章

[√] 最新文章列表

最新文章只显示最新的10篇文章。能够保证在之前高浏览量的文章存在的情况下,新的文章有一定的机会将浏览量提上去。

请求地址

/art/new

请求参数

参数名 数据类型 说明 必传
type Number 文章分类详细见上文文章参数说明 默认值1

返回示例

{
code:200,
body:[
{
id:1,
title:'文章标题',
description: '文章描述',
updatetime:'2018-06-12 12:00:00.000'
visited:560
}
……
],
message:'请求成功'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 随机推荐文章

请求地址

/art/recommend

请求参数

参数名 数据类型 说明 必传
count Number 用户当前访问推荐次数,以小程序打开 ‑‑ 关闭为一个周期,每个周期初始值为0,每访问一次+1
type Number 文章分类详细见上文文章参数说明 默认值1

返回示例

{
code:200,
body:[
{
id:1,
title:'文章标题',
description: '文章描述',
updatetime:'2018-06-12 12:00:00.000'
visited:560
}
……
],
message:'请求成功'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 最热文章列表

最新文章只显示阅读量最高的10篇文章。能够保证用户能够获取到整个数据中最受欢迎的文章。

请求地址

/art/hot

请求参数

参数名 数据类型 说明 必传
type Number 文章分类详细见上文文章参数说明 默认值1

返回示例

{
code:200,
body:[
{
id:1,
title:'文章标题',
description: '文章描述',
updatetime:'2018-06-12 12:00:00.000'
visited:560
}
……
],
message:'请求成功'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 标签筛选文章列表

请求地址

/art/label

请求参数

参数名 数据类型 说明 必传
labelId Number 标签唯一标识
pageNo Number 当前页数

返回示例

{
code:200,
body:{
art:[
{
id:1,
title:'文章标题',
description: '文章描述',
updatetime:'2018-06-12 12:00:00.000'
visited:560
}
……
],
page:{
pageNo:1,
pageSize:10,
count:100,
}
},
message:'请求成功'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 文章详情

请求地址

/art/detail

请求参数

参数名 数据类型 说明 必传
artId Number 文章唯一标识

返回示例

{
code:200,
body:{
id:1,
title:'文章标题',
description: '文章描述',
author: 'XFE-author',
content: '文章的主要内容,是markdown文本',
typename: '分类名称',
updatetime: '2018-06-12 12:00:00.000',
visited: 560,
visitor: [
{name:'标签',id:1},
……
]
},
message:'请求成功'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 收藏文章

请求地址

/art/collect/add

请求参数

参数名 数据类型 说明 必传
artId Number 标签唯一标识

返回示例

{
code:403,
body:{},
message:'用户信息验证失败'
}
{
code:405,
body:{},
msg:'缺少参数 xxx'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}
{
code:200,
body:{},
message:'文章收藏成功'
}

[√] 收藏文章列表

请求地址

/art/collect/list

请求参数

参数名 数据类型 说明 必传
pageNo Number 当前页数

返回示例

{
code:200,
body:{
art:[
{
id:1,
title:'文章标题',
description: '文章描述',
updatetime:'2018-06-12 12:00:00.000'
visited:560
}
……
],
page:{
pageNo:1,
pageSize:10,
count:100,
}
},
message:'请求成功'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 取消收藏

请求地址

/art/collect/del

请求参数

参数名 数据类型 说明 必传
artId Number 标签唯一标识

返回示例

{
code:403,
body:{},
message:'用户信息验证失败'
}
{
code:405,
body:{},
message:'缺少参数 xxx'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}
{
code:200,
body:{},
message:'文章取消收藏成功'
}

标签

[√] 所有标签列表

请求地址

/tag/list

请求参数

{
type:'13'
}

参数说明

由于是接口新添加参数,当参数未传的情况下默认为值为: 13

参数名 数据类型 说明 必传
type Number 标签所属类别

标签类别枚举值

说明
13 IT技术文章标签
14 文集标签
15 工具标签
16 笔记标签
17 生活文章标签

返回示例

{
code:200,
body:[
{
id:1,
name:'标签名',
count: 10, //与标签关联的文章数量
}
……
],
message:'请求成功'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}

[√] 标签详情

请求地址

/label/detail

请求参数

参数名 数据类型 说明 必传
labelId Number 标签ID

返回示例

{
code:200,
body:{
id:1,
name:'标签名',
artcount: 10, //与标签关联的文章数量
}
message:'请求成功'
}
{
code:500,
body:{},
message:'服务器遇到错误'
}