悟空知识库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包装对象。核心控制器分布如下控制器基础路径职责KmKnowledgeLibraryController.java/kmKnowledgeLibrary知识库增删改查、成员、搜索KmDocumentController.java/kmDocument文档增删改查、移动、点赞KmFolderController.java/kmFolder文件夹树、移动、删除KmAuthController.java/kmAuth文档/文件夹操作权限KmGroupController.java/kmGroup知识库分组管理KmDocumentLabelController.java/kmDocumentLabel文档标签KmCollectController.java/kmCollect收藏管理KmDocumentShareController.java/kmDocumentShare文档分享KmActionRecordController.java/kmActionRecord操作记录与回收站通用约定除文件下载外所有接口均为POST方法参数既可放在 URL 查询串RequestParam/PathVariable也可放在 JSON 请求体RequestBody每个控制器通过Api(tags...)注解声明分组方便生成接口文档。二、知识库接口清单/kmKnowledgeLibrary管理知识空间的顶层容器是新手对接时最先接触的模块。接口路径功能说明/kmKnowledgeLibrary/initKmData初始化知识库系统初始化数据/kmKnowledgeLibrary/add新建知识库请求体SetKmKnowledgeLibraryBO/kmKnowledgeLibrary/update编辑知识库需携带 libraryId/kmKnowledgeLibrary/delete/{libraryId}删除知识库移入回收站/kmKnowledgeLibrary/completelyDelete彻底删除知识库不可恢复慎用/kmKnowledgeLibrary/updateMember修改团队成员请求体UpdateMemberBO/kmKnowledgeLibrary/exitMember退出团队/kmKnowledgeLibrary/queryMember查询团队成员返回QueryMemberVO列表/kmKnowledgeLibrary/queryList查询知识库列表支持按 groupId、star 过滤/kmKnowledgeLibrary/queryById查询知识库详情参数libraryId/kmKnowledgeLibrary/queryDocumentByLibraryId分页查询库下文档请求体LibraryPageBO/kmKnowledgeLibrary/queryCollectDocumentByLibraryId查询库下收藏文档/kmKnowledgeLibrary/queryLibraryTemplate查询知识库模板内置模板库/kmKnowledgeLibrary/search全局文档搜索请求体SearchBO依赖 Elasticsearch/kmKnowledgeLibrary/getAISwitch查询 AI 服务开关三、文档接口清单/kmDocument文档是知识库的核心实体支持在线编辑、移动、软删除与彻底删除两种删除策略。接口路径功能/kmDocument/add添加文档/kmDocument/update修改文档/kmDocument/move移动文档MoveDocumentBO/kmDocument/queryById文档详情DocumentDetailVO/kmDocument/queryInfoById通过消息卡片查看文档信息/kmDocument/delete删除文档进回收站/kmDocument/completelyDelete彻底删除文档/kmDocument/favor文档点赞/取消点赞/kmDocument/getAllFieldLanguageRel查询多语言字段 Key前端对应的调用封装可参考 doc.js其中根据documentId是否存在自动切换add/update两个接口是典型的 RESTful 客户端写法。四、文件夹接口清单/kmFolder文件夹负责知识库内的目录结构接口以树为单位返回接口路径功能/kmFolder/add添加文件夹/kmFolder/update修改文件夹/kmFolder/delete删除文件夹/kmFolder/completelyDelete彻底删除文件夹/kmFolder/queryTreeList查询文件夹树TreeListVO/kmFolder/move移动文件夹/kmFolder/queryById文件夹详情五、权限与成员接口清单/kmAuth权限体系控制谁能看、谁能改每个文档与文件夹共 3 个接口接口路径功能说明/kmAuth/addAuth添加权限请求体AddAuthBO支持角色级别授权/kmAuth/updateAuth修改权限请求体UpdateAuthBO/kmAuth/deleteAuthUser删除权限请求体KmAuthUser⚠️ 权限校验贯穿各接口例如文件下载接口 KmFileController.java 会先通过kmAuthService.getFolderOrDocumentAuth()判断角色无权限时抛出KM_AUTH_ERROR。因此调用任何知识库 API 前先确保携带有效登录凭证。六、辅助接口分组、标签、收藏与分享知识库分组/kmGroupaddGroup、updateGroup、updateGroupBatch、searchGroupList、removeGroupById用于把多个知识库归类KmGroupManagementController.java 还提供更细粒度的moveToGroup/removeToGroup/searchLibraryGroupList。文档标签/kmDocumentLabeladd、update、deleteById/{labelId}、queryList、queryDocumentByLabelId按标签检索文档。收藏/kmCollectaddCollect、cancelCollect、queryList三个接口。分享/kmDocumentShareopenShare生成外部分享链接、addShareMember、closeShare、queryShareSys/{documentId}。操作记录与回收站/kmActionRecordqueryList、queryDeleteList、queryLibraryDeleteList、restore一键恢复误删内容。七、新手上手建议先跑通只读接口用/kmKnowledgeLibrary/queryList和/kmFolder/queryTreeList拉取现有数据理解Result返回结构写操作注意两级删除delete只是移入回收站completelyDelete不可恢复对照前端源码ux/src/api/knowledge/下按模块拆分的 folder.js、group.js、label.js 等文件是最贴近实战的接口调用示例数据库结构建表语句见 wk_open_km.sql实体类KmKnowledgeLibrary、KmDocument、KmFolder、KmAuth等 PO位于 entity/PO 目录与接口字段一一对应。掌握以上清单后你就可以基于悟空知识库 API完成外部系统集成的第一步了 【免费下载链接】Wukong_KnowledgeBase悟空知识库提供全面的知识管理功能您可以在知识库中编辑wiki信息同时可以将知识库内容共享给同事进行协同创作。项目地址: https://gitcode.com/gh_mirrors/wu/Wukong_KnowledgeBase创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考