企业官网建设流程全解析

悟空知识库API参考：知识库、文档、文件夹与权限REST接口完整清单

【免费下载链接】Wukong_KnowledgeBase悟空知识库，提供全面的知识管理功能，您可以在知识库中编辑wiki信息，同时可以将知识库内容共享给同事，进行协同创作。项目地址: https://gitcode.com/gh_mirrors/wu/Wukong_KnowledgeBase

悟空知识库是一款开源的知识管理系统，支持在线编辑 Wiki、团队协作创作与文档共享。本文带你快速读懂悟空知识库 API：基于后端 Spring Cloud 控制器逐条整理出知识库、文档、文件夹、权限四大核心 REST 接口清单，并附分组、标签、收藏、分享等辅助接口，帮助新手快速完成系统对接与二次开发。

一、API 在哪里：后端控制器结构总览

所有知识库接口都集中在km/km-web模块的 Controller 层，采用 Spring MVC + Swagger 注解，统一返回Result包装对象。核心控制器分布如下：

💡通用约定：除文件下载外，所有接口均为POST方法；参数既可放在 URL 查询串（@RequestParam/@PathVariable），也可放在 JSON 请求体（@RequestBody）；每个控制器通过@Api(tags=...)注解声明分组，方便生成接口文档。

二、知识库接口清单（/kmKnowledgeLibrary）

管理知识空间的"顶层容器"，是新手对接时最先接触的模块。

三、文档接口清单（/kmDocument）

文档是知识库的核心实体，支持在线编辑、移动、软删除与彻底删除两种删除策略。

前端对应的调用封装可参考 doc.js，其中根据documentId是否存在自动切换add/update两个接口，是典型的 RESTful 客户端写法。

四、文件夹接口清单（/kmFolder）

文件夹负责知识库内的目录结构，接口以"树"为单位返回：

五、权限与成员接口清单（/kmAuth）

权限体系控制"谁能看、谁能改"每个文档与文件夹，共 3 个接口：

⚠️ 权限校验贯穿各接口：例如文件下载接口 KmFileController.java 会先通过kmAuthService.getFolderOrDocumentAuth()判断角色，无权限时抛出KM_AUTH_ERROR。因此调用任何知识库 API 前先确保携带有效登录凭证。

六、辅助接口：分组、标签、收藏与分享

• 知识库分组（/kmGroup）：addGroup、updateGroup、updateGroupBatch、searchGroupList、removeGroupById，用于把多个知识库归类；KmGroupManagementController.java 还提供更细粒度的moveToGroup/removeToGroup/searchLibraryGroupList。
• 文档标签（/kmDocumentLabel）：add、update、deleteById/{labelId}、queryList、queryDocumentByLabelId（按标签检索文档）。
• 收藏（/kmCollect）：addCollect、cancelCollect、queryList三个接口。
• 分享（/kmDocumentShare）：openShare（生成外部分享链接）、addShareMember、closeShare、queryShareSys/{documentId}。
• 操作记录与回收站（/kmActionRecord）：queryList、queryDeleteList、queryLibraryDeleteList、restore（一键恢复误删内容）。

七、新手上手建议

1. 先跑通只读接口：用/kmKnowledgeLibrary/queryList和/kmFolder/queryTreeList拉取现有数据，理解Result返回结构；
2. 写操作注意两级删除：delete只是移入回收站，completelyDelete不可恢复；
3. 对照前端源码：ux/src/api/knowledge/下按模块拆分的 folder.js、group.js、label.js 等文件，是最贴近实战的接口调用示例；
4. 数据库结构：建表语句见 wk_open_km.sql，实体类（KmKnowledgeLibrary、KmDocument、KmFolder、KmAuth等 PO）位于 entity/PO 目录，与接口字段一一对应。

掌握以上清单后，你就可以基于悟空知识库 API完成外部系统集成的第一步了 🚀

【免费下载链接】Wukong_KnowledgeBase悟空知识库，提供全面的知识管理功能，您可以在知识库中编辑wiki信息，同时可以将知识库内容共享给同事，进行协同创作。项目地址: https://gitcode.com/gh_mirrors/wu/Wukong_KnowledgeBase