说明

这是一个毕业设计，与2019年3月6日开始编写，由于前几天没有使用git所以没有记录；目前打算使用koa+Vue完成，尽量做到每天写一点，实习还是挺累的。

API

返回格式说明

参数	返回时机	解释
msg	ALL	此次操作结果的说明
status	ALL	状态码；“-1”为错误，”0为正确“
info	NO ALL	返回时携带的信息

---

登陆

Request

• Method: POST

• URL: /user/login

• headers: Content-Type:application/json;charset=utf-8

• Body:

  {
      "user": "You name",
      "password": "You password"
  }

Response

{
    "msg": "授权成功！",
    "data": {
        "user": "You name",
        "token": "You token",
    },
    "status": "0",
}

文章归档

Request

• Method：GET
• URL：/archive/lists

Response

{
    "msg": "查询成功",
    "info": {
        "data": "数据"
    },
    "status": "0"
}

字段	值	说明
year	Number	归档年份
month	Number	归档月份
list	Object	当前归档时间的列表

文章相关

发表文章

Request

• Method： POST

• URL： /articles/add

• Headers：authorization:you_token

• Body:

  {
      "title": "文章标题",
      "content": "文章内容",
      "tag": "文章标签,逗号分隔",
      "kind": "文章分类,逗号分隔"
  }

更新文章

Request

• Method： PUT

• URL： /articles/updata

• Headers：authorization:you_token

• Body:

  {
      "title": "文章标题",
      "content": "文章内容",
      "tag": "文章标签,逗号分隔",
      "kind": "文章分类,逗号分隔"
  }

文章列表

Request

• Method： GET
• URL： /articles/lists/?limit=10&page=1

参数	说明	是否必须
limit	每次查询的文章数量	是
page	查询的页码(>=1)	是

Response

{
    "msg": "查询成功",
    "info": {
        "totalCount": "文章总数量",
        "count": "查询结果的数量",
        "page": "当前页码",
        "data": "查询结果"
    },
    "status": "0"
}

文章内容

Request

• Method：GET

• URL：/articles/lists/:id

  参数	说明
  :id	文章ID

• eg：/articles/lists/1

Response

{
    "msg": "查询成功",
    "info": {
        "data": "文章数据"
    },
    "status": "0"
}

删除文章

Request

• Method：DELETE

• URL：/articles/lists/:id

  参数	说明
  :id	文章ID

• eg：/articles/delete/?id=1

文章搜索

Request

• Method：GET

• URL：/articles/search/

  参数	说明
  content	搜索内容(暂时只搜索标题)

• eg：/articles/search/?content=数据结构

Response

{
    "msg": "查询成功",
    "info": {
        "data": "文章数据"
    },
    "status": "0"
}

留言相关

提交留言

Request

• Method：POST

• URL：/comments/add

  参数	说明	是否必须
  cid	留言所属文章id	是
  post	留言内容	是
  name	留言者称呼	是
  email	留言者邮箱	否
  url	留言者主页	否
  parent	父级留言ID	是

查询文章留言

Request

• Method：GET

• URL：/comments/lists/:cid

  参数	说明
  :cid	文章ID

• eg：/comments/lists/1

Response

{
    "msg": "查询成功",
    "info": {
        "data": "留言数据内容"
    },
    "status": "0"
}

留言列表

Request

• Method：GET
• URL：/comments/lists
• info：(所有留言，后台使用)

Response

{
    "msg": "查询成功",
    "info": {
        "data": "留言数据内容"
    },
    "status": "0"
}

删除留言

Request

• Method：DELETE

• URL：/comments/delete/?id=:id

• Headers：authorization:you_token

  参数	说明
  id	留言ID

分类相关

分类列表

Request

• Method：GET
• URL：/kinds/lists/

Response

{
    "msg": "查询成功",
    "info": {
        "data": "分类列表"
    },
    "status": "0"
}

添加分类

Request

• Method：POST

• URL：/kinds/add/

• Headers：authorization:you_token

  参数	说明
  name	分类名字
  parent	父级ID(未实现，传任意值)

删除分类

Request

• Method：DELETE

• URL：/kinds/delete/?id=:id

• Headers：authorization:you_token

  参数	说明
  id	分类ID

标签相关

标签列表

Request

• Method：GET
• URL：/tags/lists/

Response

{
    "msg": "查询成功",
    "info": {
        "data": "标签列表"
    },
    "status": "0"
}

添加标签

Request

• Method：POST

• URL：/tags/add/

• Headers：authorization:you_token

  参数	说明
  name	标签名字

删除标签

Request

• Method：DELETE

• URL：/tags/delete/?id=:id

• Headers：authorization:you_token

  参数	说明
  id	标签ID

License

MIT

Copyright (c) 2019, Curtion