博客

# 文章

# 获取文章列表

GET /admin/articles

GET /articles?tagID=ObjectId&categoryID=ObjectId

# Query String Parameters

Field Type Description Required
categoryID ObjectId 文章分类ID No
tagID ObjectId 文章标签ID No

# Response

[
  {
    "tagIdList": ["5d95a0600c64f55a9b6ca863"],
    "content": {
      "html": "<div>html</div>",
      "text": "text"
    },
    "starCount": 3,
    "cover": {
      "name": "1570325210405.jpg",
      "path": "/uploads/1570325210405.jpg"
    },
    "pv": 28,
    "isPublished": true,
    "title": "起步",
    "categoryID": "5d92ab8c0c64f55a9b6ca85e",
    "createdAt": "2019-10-03T07:35:39.180Z",
    "updatedAt": "2019-10-08T06:42:29.794Z",
    "category": {
      "name": "前端开发",
      "createdAt": "2019-10-01T01:27:40.345Z",
      "updatedAt": "2019-10-01T01:27:40.345Z",
      "id": "5d92ab8c0c64f55a9b6ca85e"
    },
    "id": "5d95a4cb0c64f55a9b6ca869",
    "comments": [],
    "tagList": [
      {
        "name": "VueJs",
        "createdAt": "2019-10-03T07:16:48.824Z",
        "updatedAt": "2019-10-03T07:16:48.824Z",
        "id": "5d95a0600c64f55a9b6ca863"
      }
    ]
  }
]

# 获取推荐文章列表

GET /articles/suggestion?tagIdList=ObjectId&tagIdList=ObjectId

# Query String Parameters

Field Type Description Required
tagIdList Array<ObjectId> 文章标签ID列表 Yes

# Response

[
  {
    "tagIdList": ["5d95a09d0c64f55a9b6ca866"],
    "content": {
      "html": "<div>html</div>",
      "text": "text"
    },
    "starCount": 2,
    "cover": {
      "name": "1570325227437.jpg",
      "path": "/uploads/1570325227437.jpg"
    },
    "pv": 15,
    "isPublished": true,
    "title": "2019年MongoDB中文社区 台北大会",
    "categoryID": "5d95a0570c64f55a9b6ca862",
    "createdAt": "2019-10-03T07:20:47.593Z",
    "updatedAt": "2019-10-10T03:10:39.219Z",
    "id": "5d95a14f0c64f55a9b6ca867"
  }
]

# 获取文章详情

GET /admin/articles/:id

GET /articles/:id

# Response

{
  "tagIdList": ["5d95a09d0c64f55a9b6ca866"],
  "content": { "html": "<div>文章内容</div>", "text": "文章内容" },
  "starCount": 1,
  "cover": { "name": "", "path": "" },
  "pv": 3,
  "isPublished": true,
  "title": "文章标题",
  "categoryID": "5d95a0570c64f55a9b6ca862",
  "createdAt": "2019-10-09T07:51:30.590Z",
  "updatedAt": "2019-10-10T03:11:43.306Z",
  "tagList": [{}],
  "commentList": [{}],
  "id": "5d9d9182246364202c897066"
}

# 添加文章

POST /admin/articles

# Request

Field Type Description Required
categoryID ObjectId 文章分类ID Yes
tagIdList Array<ObjectId> 文章标签ID列表 No
title String 文章标题 Yes
content Markdown 文章内容 Yes
cover File 文章封面 Yes
isPublished Boolean 是否发布 Yes

# Response

HTTP1.1 201

{
  "starCount": 0,
  "tagIdList": [
    "5d95a09d0c64f55a9b6ca866"
  ],
  "isPublished": true,
  "pv": 0,
  "categoryID": "5d95a0570c64f55a9b6ca862",
  "title": "文章标题",
  "content": {
    "html": "<div>文章内容</div>",
    "text": "文章内容"
  },
  "cover": {
    "name": "",
    "path": ""
  },
  "id": "5d9d9182246364202c897066",
  "createdAt": "2019-10-09T07:51:30.590Z",
  "updatedAt": "2019-10-09T07:51:30.590Z"
}

# 编辑文章

PATCH /admin/articles/:id

# Request

Field Type Description Required
categoryID ObjectId 文章分类ID No
tagIdList Array<ObjectId> 文章标签ID列表 No
title String 文章标题 No
content Markdown 文章内容 No
cover File 封面 No
isPublished Boolean 是否发布 No

# Response

HTTP1.1 204 No Content

# 删除文章

DELETE /admin/articles/:id

# Response

HTTP/1.1 204 No Content

# 关注文章

PATCH /articles/:id/star

# Response

HTTP/1.1 204 No Content

# 获取首页文章轮播图

GET /articles/carousels

# Response

[
  {
    "tagIdList": ["5d95a0600c64f55a9b6ca863"],
    "content": {
      "html": "<div>html</div>",
      "text": "text"
    },
    "starCount": 3,
    "cover": {
      "name": "1570325210405.jpg",
      "path": "/uploads/1570325210405.jpg"
    },
    "pv": 31,
    "isPublished": true,
    "title": "起步",
    "categoryID": "5d92ab8c0c64f55a9b6ca85e",
    "createdAt": "2019-10-03T07:35:39.180Z",
    "updatedAt": "2019-10-10T03:11:06.125Z",
    "category": {
      "name": "前端开发",
      "createdAt": "2019-10-01T01:27:40.345Z",
      "updatedAt": "2019-10-01T01:27:40.345Z",
      "id": "5d92ab8c0c64f55a9b6ca85e"
    },
    "id": "5d95a4cb0c64f55a9b6ca869",
    "comments": [{}],
    "tagList": [{}]
  }
]

← 文章分类 →