1. 珠峰博客接口文档 #

• 登录
  • post /api/users/singup 注册
  • post /api/users/signin 登录
  • get /api/users/signout 登出

• 分类列表
  • get /api/categories 列表
  • post /api/categories 增加
  • put /api/categories/:id 编辑
  • delete /api/categories/:id 删除

• 文章列表
  • get /api/articles 列表
  • post /api/articles 增加
  • put /api/articles/:id 编辑
  • delete /api/articles/:id 删除
  • get /api/articles/pv/:id 增加pv
  • post /api/articles/:id 增加评论

    2.用户 #

    2.1 用户注册 #

    2.1.1 请求路径 #

    /api/users/singup

    2.1.2 请求方法 #

    POST

    2.1.3 请求参数 #

    放在请求体里

    {
    "username":"zfpx", //用户名
    "password":"123456", //密码
    "email":"[email protected]" //邮箱
    }
    

2.1.4 响应 #

{
    "result": {
        "code":0,//成功，其他数字则为不成功
        "message":"success"
    }
}

2.2 用户登录 #

2.2.1 请求路径 #

/api/users/singin

2.2.2 请求方法 #

POST

2.2.3 请求参数 #

放在请求体里

{
   "username":"zfpx", //用户名
   "password":"123456", //密码
}

2.2.4 响应 #

{
    "code":0,//成功，其他数字则为不成功
    "message":"success"
}

2.3 用户退出 #

2.3.1 请求路径 #

/api/users/singout

2.3.2 请求方法 #

GET

2.3.3 请求参数 无 #

2.3.4 响应 #

{
    "code":0,//成功，其他数字则为不成功
    "message":"success"
}

3.分类 #

3.1 分类列表 #

3.1.1 请求名称 #

/api/categories

3.1.2 请求方法 #

GET

3.1.3 请求参数 #

3.1.4 响应 #

{
    "code": 0,
    "data": {
        "items": [
             {"_id":1,"name":"分类名称"},
        ]
    }
}

3.2 增加分类 #

3.2.1 请求名称 #

/api/categories

3.2.2 请求方法 #

POST

3.2.3 请求参数 #

{
   "name":"分类名称"
}

3.2.4 响应 #

{
    "code":0,
    "message":"success"
}

3.3 编辑分类 #

3.3.1 请求名称 #

/api/categories/:id

3.3.2 请求方法 #

PUT

3.3.3 请求参数 #

此参数放在请求体里

{
    "name":"xxx",//新分类名称
}

3.3.4 响应 #

{
    "result": {
        "code":0,//成功，其他数字则为不成功
        "message":"success" // 成功为success不成功，显示不成功原因
    }
}

3.4 删除分类 #

3.4.1 请求名称 #

/api/categories/:id

3.4.2 请求方法 #

DELETE

3.4.3 请求参数 #

• id:1

路径参数

响应 #

{
    "code":0,
    "message":"success"
}

4. 文章 #

4.1 文章列表 #

4.1.1 请求名称 #

/api/articles

4.1.2 请求方法 #

GET

4.1.3 请求参数 #

放在URL地址中的查询字符串里

• "pageNum":1, //显示当前显示的页
• "pageSize":5, //显示每页条数是5
• "keyword":"a" //关键字

pageNum=1&pageSize=5&keyword=a

4.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 增加博客 #

4.2.1 请求名称 #

/api/articles

4.2.2 请求方法 #

POST

4.2.3 请求参数 #

{
   "title":"标题1",
   "content":"内容1"
}

4.2.4 响应 #

{
    "code":0,//成功，其他数字则为不成功
    "message":"success"
}

4.3 编辑文章 #

4.3.1 请求名称 #

/api/articles/:id

4.3.2 请求方法 #

PUT

4.3.3 请求参数 #

此参数放在请求体里

{
    "title":"xxx",   //该博客的新标题
    "content":"xxx", // 该博客的新内容
}

4.3.4 响应 #

{
    "result": {
        "code":0,//成功，其他数字则为不成功
        "message":"success" // 成功为success不成功，显示不成功原因
    }
}

4.4 删除文章 #

4.4.1 请求名称 #

/api/articles/:id

请求方法 #

DELETE

4.4.2 请求参数 #

• id:1, 文章的ID

路径参数

4.4.3 响应 #

{
    "code":0,
    "message":"success"
}

4.5 增加评论数 #

4.5.1 请求名称 #

/api/articles/pv/:id

4.5.2 请求方法 #

GET

4.5.3 请求参数 #

无

4.5.4 响应 #

{
    "result": {
        "code":0,//成功，其他数字则为不成功
        "message":"success" // 成功为success不成功，显示不成功原因
    }
}

4.6 文章评论 #

4.6.1 请求名称 #

/api/articles/comment/:id

4.6.2 请求方法 #

POST

4.6.3 请求参数 #

{
   "content":"xxx", // 评论内容
}

4.6.4 响应 #

{
    "result": {
        "code":0,//成功，其他数字则为不成功
        "message":"success" // 成功为success不成功，显示不成功原因
    }
}