沐枫博客接口文档
登录
分类列表
文章列表
2.用户 #
2.1 用户注册 [#](#t22.1 用户注册)
2.1.1 请求路径 [#](#t32.1.1 请求路径)
/api/users/singup
2.1.2 请求方法 [#](#t42.1.2 请求方法)
POST
2.1.3 请求参数 [#](#t52.1.3 请求参数)
放在请求体里
{
"username":"zxmf", //用户名
"password":"123456", //密码
"email":"zxmf@qq.com" //邮箱
}
2.1.4 响应 [#](#t62.1.4 响应)
{
"result": {
"code":0,//成功，其他数字则为不成功
"message":"success"
}
}
2.2 用户登录 [#](#t72.2 用户登录)
2.2.1 请求路径 [#](#t82.2.1 请求路径)
/api/users/singin
2.2.2 请求方法 [#](#t92.2.2 请求方法)
POST
2.2.3 请求参数 [#](#t102.2.3 请求参数)
放在请求体里
{
"username":"zxmf", //用户名
"password":"123456", //密码
}
2.2.4 响应 [#](#t112.2.4 响应)
{
"code":0,//成功，其他数字则为不成功
"message":"success"
}
2.3 用户退出 [#](#t122.3 用户退出)
2.3.1 请求路径 [#](#t132.3.1 请求路径)
/api/users/singout
2.3.2 请求方法 [#](#t142.3.2 请求方法)
GET
2.3.3 请求参数 无 [#](#t152.3.3 请求参数 无)
2.3.4 响应 [#](#t162.3.4 响应)
{
"code":0,//成功，其他数字则为不成功
"message":"success"
}
3.分类 #
3.1 分类列表 [#](#t183.1 分类列表)
3.1.1 请求名称 [#](#t193.1.1 请求名称)
/api/categories
3.1.2 请求方法 [#](#t203.1.2 请求方法)
GET
3.1.3 请求参数 [#](#t213.1.3 请求参数)
3.1.4 响应 [#](#t223.1.4 响应)
{
"code": 0,
"data": {
"items": [
{"_id":1,"name":"分类名称"},
]
}
}
3.2 增加分类 [#](#t233.2 增加分类)
3.2.1 请求名称 [#](#t243.2.1 请求名称)
/api/categories
3.2.2 请求方法 [#](#t253.2.2 请求方法)
POST
3.2.3 请求参数 [#](#t263.2.3 请求参数)
{
"name":"分类名称"
}
3.2.4 响应 [#](#t273.2.4 响应)
{
"code":0,
"message":"success"
}
3.3 编辑分类 [#](#t283.3 编辑分类)
3.3.1 请求名称 [#](#t293.3.1 请求名称)
/api/categories/:id
3.3.2 请求方法 [#](#t303.3.2 请求方法)
PUT
3.3.3 请求参数 [#](#t313.3.3 请求参数)
此参数放在请求体里
{
"name":"xxx",//新分类名称
}
3.3.4 响应 [#](#t323.3.4 响应)
{
"result": {
"code":0,//成功，其他数字则为不成功
"message":"success" // 成功为success不成功，显示不成功原因
}
}
3.4 删除分类 [#](#t333.4 删除分类)
3.4.1 请求名称 [#](#t343.4.1 请求名称)
/api/categories/:id
3.4.2 请求方法 [#](#t353.4.2 请求方法)
DELETE
3.4.3 请求参数 [#](#t363.4.3 请求参数)
- id:1
路径参数
响应 #
{
"code":0,
"message":"success"
}
4. 文章 [#](#t384. 文章)
4.1 文章列表 [#](#t394.1 文章列表)
4.1.1 请求名称 [#](#t404.1.1 请求名称)
/api/articles
4.1.2 请求方法 [#](#t414.1.2 请求方法)
GET
4.1.3 请求参数 [#](#t424.1.3 请求参数)
放在URL地址中的查询字符串里
"pageNum":1, //显示当前显示的页
"pageSize":5, //显示每页条数是5
"keyword":"a" //关键字
pageNum=1&pageSize=5&keyword=a
4.1.4 响应 [#](#t434.1.4 响应)
{
"code": 0,
"data": {
"articles": [
{
"pv": 0,
"comments": [
{
"createAt": "2018-04-30T14:00:31.417Z",
"_id": "5ae7217f176d5a17507d6ae9",
"content": "评论内容1",
"user": "5ae70c24a8003f0cdcfc4ebc"
},
{
"createAt": "2018-04-30T14:06:09.560Z",
"_id": "5ae722d18463811c606f4643",
"content": "评论内容2",
"user": "5ae70c24a8003f0cdcfc4ebc"
}
],
"createAt": "2018-04-30T13:54:31.198Z",
"_id": "5ae720178633281b481757fc",
"title": "标题2",
"content": "内容2",
"user": "5ae70c24a8003f0cdcfc4ebc",
"__v": 0
},
],//文章列表
"pageNum": 1,//当前页码
"pageSize": 5,//每页条数
"total": 9,//总条数
"pageCount": 2//总页数
}
}
4.2 增加博客 [#](#t444.2 增加博客)
4.2.1 请求名称 [#](#t454.2.1 请求名称)
/api/articles
4.2.2 请求方法 [#](#t464.2.2 请求方法)
POST
4.2.3 请求参数 [#](#t474.2.3 请求参数)
{
"title":"标题1",
"content":"内容1"
}
4.2.4 响应 [#](#t484.2.4 响应)
{
"code":0,//成功，其他数字则为不成功
"message":"success"
}
4.3 编辑文章 [#](#t494.3 编辑文章)
4.3.1 请求名称 [#](#t504.3.1 请求名称)
/api/articles/:id
4.3.2 请求方法 [#](#t514.3.2 请求方法)
PUT
4.3.3 请求参数 [#](#t524.3.3 请求参数)
此参数放在请求体里
{
"title":"xxx", //该博客的新标题
"content":"xxx", // 该博客的新内容
}
4.3.4 响应 [#](#t534.3.4 响应)
{
"result": {
"code":0,//成功，其他数字则为不成功
"message":"success" // 成功为success不成功，显示不成功原因
}
}
4.4 删除文章 [#](#t544.4 删除文章)
4.4.1 请求名称 [#](#t554.4.1 请求名称)
/api/articles/:id
请求方法 #
DELETE
4.4.2 请求参数 [#](#t574.4.2 请求参数)
- id:1, 文章的ID
路径参数
4.4.3 响应 [#](#t584.4.3 响应)
{
"code":0,
"message":"success"
}
4.5 增加评论数 [#](#t594.5 增加评论数)
4.5.1 请求名称 [#](#t604.5.1 请求名称)
/api/articles/pv/:id
4.5.2 请求方法 [#](#t614.5.2 请求方法)
GET
4.5.3 请求参数 [#](#t624.5.3 请求参数)
无
4.5.4 响应 [#](#t634.5.4 响应)
{
"result": {
"code":0,//成功，其他数字则为不成功
"message":"success" // 成功为success不成功，显示不成功原因
}
}
4.6 文章评论 [#](#t644.6 文章评论)
4.6.1 请求名称 [#](#t654.6.1 请求名称)
/api/articles/comment/:id
4.6.2 请求方法 [#](#t664.6.2 请求方法)
POST
4.6.3 请求参数 [#](#t674.6.3 请求参数)
{
"content":"xxx", // 评论内容
}
4.6.4 响应 [#](#t684.6.4 响应)
{
"result": {
"code":0,//成功，其他数字则为不成功
"message":"success" // 成功为success不成功，显示不成功原因
}
}
Gitalking ...
Be the first guy leaving a comment!