Skip to content

数据模型与接口速查

本页汇总知识中心的枚举、表结构、权限码、设置键、通知事件与 API 路径。

枚举

枚举
wiki_space_visibilitypublic(全员可读)、private(成员可见)
wiki_space_member_roleowneradmineditorviewer
wiki_doc_statusdraftpendingpublishedrejected
wiki_comment_statusvisiblehidden
wiki_review_actionsubmitapproverejectwithdraw
WIKI_GOVERNANCE_KINDSallexpiredreview-duestaleno-ownerdraft-backlogreview-backlogarchived

数据表

表名关键字段说明
wiki_spacesnamevisibilitystatussortai_sync_enabledtenant_id知识空间
wiki_space_membersspace_iduser_idrole空间成员,复合主键
wiki_docsspace_idparent_idtitlesummarycontentstatusreject_reasonsortis_pinnedview_countcurrent_versionrevisionrequire_read_receiptowner_idexpire_atreview_cycle_daysnext_review_atis_archivedpublished_atdeleted_attenant_id文档主表
wiki_doc_versionsdoc_idversiontitlecontentchange_noteauthor_id文档版本快照,doc_id + version 唯一
wiki_templatesnamedescriptioncontentstatussort文档模板
wiki_tagsnamecolor标签,name 唯一
wiki_doc_tagsdoc_idtag_id文档标签关联,复合主键
wiki_commentsdoc_idparent_idcontentstatusmentioned_user_idsis_questionresolved_atauthor_id评论与回复
wiki_doc_favoritesdoc_iduser_id收藏,复合主键
wiki_doc_viewsdoc_iduser_idcreated_at浏览日志
wiki_search_logskeywordresult_countclicked_doc_iduser_idtenant_idcreated_at搜索日志
wiki_doc_subscriptionsdoc_iduser_id文档订阅,复合主键
wiki_review_recordsdoc_idversionactionactor_idreason审核时间线
wiki_doc_read_receiptsdoc_iduser_idcreated_at阅读确认,复合主键
business_filesbusiness_type = 'wiki_doc'business_id = docId文档附件多态关联
system_configsconfig_key = wiki.*知识中心全局设置

设置键

ts
wiki.requireApproval
wiki.defaultVisibility
wiki.aiSyncEnabled
wiki.aiSyncKbId
wiki.commentsEnabled
wiki.recycleRetentionDays
wiki.pendingRemindHours

通知事件

事件 Key说明
wiki.doc.published订阅的知识文档发布新版本
wiki.doc.commented文档收到新评论
wiki.doc.mentioned评论中被 @ 提及
wiki.doc.reviewed文档审核结果
wiki.governance.maintenance_due文档待维护提醒
wiki.governance.review_due文档复审到期 / 已过有效期

权限码

text
wiki:doc:list
wiki:doc:create
wiki:doc:edit
wiki:doc:delete
wiki:doc:publish
wiki:doc:move
wiki:space:list
wiki:space:create
wiki:space:edit
wiki:space:delete
wiki:space:grant
wiki:approval:list
wiki:approval:review
wiki:template:list
wiki:template:create
wiki:template:edit
wiki:template:delete
wiki:tag:list
wiki:tag:create
wiki:tag:edit
wiki:tag:delete
wiki:comment:list
wiki:comment:audit
wiki:comment:delete
wiki:recycle:list
wiki:recycle:restore
wiki:recycle:purge
wiki:stats:view
wiki:setting:view
wiki:setting:edit
wiki:governance:list
wiki:governance:remind
wiki:governance:archive
wiki:governance:edit

API 路径清单

空间

方法路径
GET/api/wiki/spaces
GET/api/wiki/spaces/my
GET/api/wiki/spaces/{id}
POST/api/wiki/spaces
PUT/api/wiki/spaces/{id}
DELETE/api/wiki/spaces/{id}
GET/api/wiki/spaces/{id}/members
PUT/api/wiki/spaces/{id}/members

文档

方法路径
GET/api/wiki/docs
GET/api/wiki/docs/search
POST/api/wiki/docs/search/click
GET/api/wiki/docs/recent
GET/api/wiki/docs/reviews/processed
GET/api/wiki/docs/tree
GET/api/wiki/docs/favorites
GET/api/wiki/docs/recycle
GET/api/wiki/docs/{id}
POST/api/wiki/docs
PUT/api/wiki/docs/{id}
DELETE/api/wiki/docs/{id}
POST/api/wiki/docs/{id}/move
POST/api/wiki/docs/{id}/submit
POST/api/wiki/docs/{id}/withdraw
POST/api/wiki/docs/{id}/review
POST/api/wiki/docs/{id}/favorite
POST/api/wiki/docs/{id}/subscribe
POST/api/wiki/docs/{id}/read-receipt
GET/api/wiki/docs/{id}/read-receipts
GET/api/wiki/docs/{id}/review-records
POST/api/wiki/docs/{id}/view
GET/api/wiki/docs/{id}/versions
GET/api/wiki/docs/{id}/versions/{version}
POST/api/wiki/docs/{id}/rollback
POST/api/wiki/docs/{id}/restore
DELETE/api/wiki/docs/{id}/purge

模板、标签、评论、治理、统计、设置

方法路径
GET/api/wiki/templates
GET/api/wiki/templates/all
GET/api/wiki/templates/{id}
POST/api/wiki/templates
PUT/api/wiki/templates/{id}
DELETE/api/wiki/templates/{id}
GET/api/wiki/tags
GET/api/wiki/tags/all
POST/api/wiki/tags
PUT/api/wiki/tags/{id}
DELETE/api/wiki/tags/{id}
GET/api/wiki/comments/doc/{id}
POST/api/wiki/comments
POST/api/wiki/comments/{id}/resolve
DELETE/api/wiki/comments/mine/{id}
GET/api/wiki/comments
PUT/api/wiki/comments/{id}/status
DELETE/api/wiki/comments/{id}
GET/api/wiki/governance/docs
GET/api/wiki/governance/no-result-keywords
POST/api/wiki/governance/remind
POST/api/wiki/governance/archive
POST/api/wiki/governance/owner
POST/api/wiki/governance/review-cycle
POST/api/wiki/governance/import
GET/api/wiki/stats/overview
GET/api/wiki/stats/hot-docs
GET/api/wiki/stats/contributors
GET/api/wiki/stats/stale-docs
GET/api/wiki/stats/ops
GET/api/wiki/settings
PUT/api/wiki/settings

Built with VitePress for local documentation preview.