Skip to content

Latest commit

 

History

History
356 lines (230 loc) · 4.69 KB

api.md

File metadata and controls

356 lines (230 loc) · 4.69 KB

所有请求URL前缀 http://47.99.113.195:3000


登录

请求URL:

  • /signin

请求方式:

  • post

参数:

参数名 是否必须 类型 说明
name String 账号
password String 密码

返回示例

`200`

code:200
message:"登录成功"


注册

请求URL:

  • /signup

请求方式:

  • post

参数:

参数名 是否必须 类型 说明
name String 账号
password String 密码
repeatpass String 第二次输入的密码
avator String 头像地址

返回示例

`200`

code:200
message: '注册成功'

上传

请求URL:

  • /upload

请求方式:

  • post

参数:

参数名 是否必须 类型 说明

返回示例

`200`
    code: 200,
    message: '上传成功',
    url: '/public/images/' + `${file.name}`


所有文章分页分页,每次输出20条

请求URL:

  • /posts/page

请求方式:

  • post

参数:

参数名 是否必须 类型 说明
title String 文章标题模糊查询
page Long 当前页数,默认为1

返回示例

`200`

code:200
data:[{id: 1, name: "00063", title: "12321", content: "<p>12321</p>↵", md: "12321", uid: "1",…},…]
message:"获取成功"
total:2     ---总数一定会用到

我的文章分页分页,每次输出10条

请求URL:

  • /posts/self/page

请求方式:

  • post

参数:

参数名 是否必须 类型 说明
name String 文章作者,登录时候Cookie 存name
page Long 当前页数,默认为1

返回示例

`200`

code:200
data:[{id: 1, name: "00063", title: "12321", content: "<p>12321</p>↵", md: "12321", uid: "1",…},…]
message:"获取成功"
total:2     ---总数一定会用到

发表文章

请求URL:

  • /create

请求方式:

  • post

参数:

参数名 是否必须 类型 说明
title String 文章标题
content String 文章内容

返回示例

`200`

code:200
message:"发表文章成功"

单查文章详情

请求URL:

  • /postId/{id}

请求方式:

  • get

参数:

参数名 是否必须 类型 说明
id number 文章id

返回示例

`200`

        code: 200,
        data:{......},
        message: '查询成功'

编辑

请求URL:

  • /posts/edit

请求方式:

  • put

参数:

参数名 是否必须 类型 说明
postId number 文章id
title string 文章标题
content string 文章内容

返回示例

`200`

        code: 200,
        data:{......},
        message: '查询成功'

删除

请求URL:

  • /posts/remove/{id}

请求方式:

  • delete

参数:

参数名 是否必须 类型 说明

返回示例

`200`
{
"code": 200,
"message": "删除文章成功"
}

评论

请求URL:

  • /comment

请求方式:

  • post

参数:

参数名 是否必须 类型 说明
postId number 文章id
content string 评论内容

返回示例

"code": 200,
"message": "评论成功"


评论分页

请求URL:

  • /commentPage

请求方式:

  • post

参数:

参数名 是否必须 类型 说明
page number 页码
postId number 文章ID

返回示例

{
"code": 200,
"message": "获取成功",
"data":[{"id": 4, "name": "00064", "content": "<p>00064</p>\n", "moment": "2018-10-13 09:11:43",…],
"total": 2
}


评论删除

请求URL:

  • /comment/remove

请求方式:

  • post

参数:

参数名 是否必须 类型 说明
postId number 文章ID
commentId number 评论ID

返回示例

{
"code": 200,
"message": "删除评论成功"
}


退出登录

请求URL:

  • /signout

请求方式:

  • get

参数:

参数名 是否必须 类型 说明

返回示例

`200`

true