CarefreeCMS 文档CarefreeCMS 文档
指南
  • 内容管理
  • 多站点管理
  • AI文章生成
  • SEO优化
  • 静态化生成
API
  • FAQ
  • 更新日志
  • 贡献指南
  • v1.3.0
  • v1.2.0
  • v1.1.0
GitHub
指南
  • 内容管理
  • 多站点管理
  • AI文章生成
  • SEO优化
  • 静态化生成
API
  • FAQ
  • 更新日志
  • 贡献指南
  • v1.3.0
  • v1.2.0
  • v1.1.0
GitHub
  • API 文档

    • API 文档
    • 认证接口
    • 文章接口
    • 分类接口
    • 标签接口
    • 媒体接口
    • 评论接口
    • 用户接口

标签接口

标签管理相关的 API 接口文档。

获取标签列表

接口信息

GET /api/tags
Authorization: Bearer {token}

请求参数

参数类型必填说明
pageinteger否页码,默认1
page_sizeinteger否每页数量,默认20
keywordstring否关键词搜索
orderstring否排序字段

响应示例

{
  "code": 200,
  "message": "获取成功",
  "data": {
    "list": [
      {
        "id": 1,
        "name": "Vue.js",
        "alias": "vuejs",
        "color": "#42b983",
        "icon": "fa fa-vuejs",
        "description": "Vue.js 相关文章",
        "article_count": 25,
        "create_time": "2024-01-01 00:00:00"
      }
    ],
    "total": 50,
    "page": 1,
    "page_size": 20
  }
}

获取标签详情

接口信息

GET /api/tags/{id}
Authorization: Bearer {token}

响应示例

{
  "code": 200,
  "data": {
    "id": 1,
    "name": "Vue.js",
    "alias": "vuejs",
    "color": "#42b983",
    "icon": "fa fa-vuejs",
    "description": "Vue.js 相关文章",
    "article_count": 25,
    "create_time": "2024-01-01 00:00:00"
  }
}

创建标签

接口信息

POST /api/tags
Authorization: Bearer {token}
Content-Type: application/json

请求参数

参数类型必填说明
namestring是标签名称
aliasstring否别名,留空自动生成
colorstring否颜色
iconstring否图标
descriptionstring否描述

请求示例

{
  "name": "React",
  "alias": "react",
  "color": "#61dafb",
  "description": "React 框架相关"
}

响应示例

{
  "code": 201,
  "message": "创建成功",
  "data": {
    "id": 10,
    "name": "React",
    "alias": "react"
  }
}

更新标签

接口信息

PUT /api/tags/{id}
Authorization: Bearer {token}
Content-Type: application/json

请求参数

与创建标签相同,所有字段可选。

响应示例

{
  "code": 200,
  "message": "更新成功"
}

删除标签

接口信息

DELETE /api/tags/{id}
Authorization: Bearer {token}

响应示例

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

批量操作

批量删除

DELETE /api/tags/batch
Authorization: Bearer {token}
Content-Type: application/json

请求示例

{
  "ids": [1, 2, 3]
}

获取标签文章

接口信息

GET /api/tags/{id}/articles
Authorization: Bearer {token}

请求参数

参数类型必填说明
pageinteger否页码
page_sizeinteger否每页数量

响应示例

{
  "code": 200,
  "data": {
    "list": [
      {
        "id": 1,
        "title": "Vue 3 新特性",
        "summary": "Vue 3 带来的新特性介绍",
        "create_time": "2024-01-15 10:00:00"
      }
    ],
    "total": 25,
    "page": 1,
    "page_size": 20
  }
}

相关接口

  • 文章接口
  • 分类接口
  • 认证接口
在 GitHub 上编辑此页
Prev
分类接口
Next
媒体接口