Skip to content

专题管理插件 ​

专题插件提供将多篇文章组织为一个专题的能力,支持手动关联和自动规则关联,每个专题可独立配置 TDK SEO 信息。

插件信息 ​

属性值
名称topic
版本0.1.0
描述专题管理模块 -- 专题创建、文章关联、自动规则
管理面板是

事件 ​

事件名触发时机
topic.published专题发布
topic.article.added文章添加到专题

数据模型 ​

Topic(专题) ​

表名: topics

字段类型说明
(BaseModel)embedded
Titlestring(500)专题标题
Slugstring(500)URL 标识,租户内唯一
Descriptiontext专题描述
CoverImagestring(1000)封面图
Statusstring(20)draft / published / archived
SortOrderint排序权重
IsPinnedbool是否置顶
ArticleCountint文章数量
ViewCountint浏览次数
TDKTitlestring(200)TDK 标题
TDKDescstring(500)TDK 描述
TDKKeywordsstring(500)TDK 关键词
PublishedAt*time.Time发布时间

TopicArticle(专题文章关联) ​

表名: topic_articles

字段类型说明
(BaseModel)embedded
TopicIDuint专题 ID
ArticleIDuint文章 ID
SortOrderint排序权重
IsManualbool是否手动关联(默认 true)
AutoRuleID*uint关联的自动规则 ID

TopicAutoRule(自动关联规则) ​

表名: topic_auto_rules

字段类型说明
(BaseModel)embedded
TopicIDuint目标专题
Namestring(200)规则名称
CategoryID*uint按分类匹配
TagIDsstring(500)按标签匹配(逗号分隔)
Keywordstring(200)按关键词匹配
MaxItemsint最大文章数,默认 20
IsActivebool是否启用

API 接口 ​

公开接口 ​

方法路径说明
GET/api/v1/topics已发布专题列表
GET/api/v1/topics/:id专题详情
GET/api/v1/topics/:id/articles专题文章列表
POST/api/v1/topics/:id/view增加浏览次数

管理接口 ​

方法路径权限说明
POST/api/v1/topicstopic.write创建专题
GET/api/v1/topics/alltopic.read全部专题列表
PUT/api/v1/topics/:idtopic.write更新专题(仅创建者)
DELETE/api/v1/topics/:idtopic.write删除专题(仅创建者,级联删除关联)
POST/api/v1/topics/:id/articlestopic.write添加文章到专题
DELETE/api/v1/topics/:id/articles/:article_idtopic.write从专题移除文章

业务规则 ​

  • Slug 自动生成: 创建时如未提供 Slug,自动生成
  • 首次发布记录时间: 专题首次设为 published 时自动设置 PublishedAt
  • 所有权保护: 更新/删除仅限创建者
  • 级联删除: 删除专题时自动清理所有 topic_articles 关联记录
  • 文章计数同步: 添加/移除文章时自动更新 ArticleCount

Released under the Apache 2.0 License.