当前位置：首页 > news >正文

MrDoc API接口完全手册：自动化文档管理的秘密武器

news 2026/6/11 20:06:34

MrDoc API接口完全手册：自动化文档管理的秘密武器

【免费下载链接】MrDocmrdoc,online document system developed based on python. It is suitable for individuals and small teams to manage documents, wiki, knowledge and notes. 觅思文档，适合于个人和中小型团队的在线文档、知识库系统。项目地址: https://gitcode.com/gh_mirrors/mr/MrDoc

觅思文档（MrDoc）是一款基于Python开发的在线文档系统，专为个人和中小型团队设计，提供强大的文档、Wiki和知识库管理功能。本指南将详细介绍MrDoc的API接口，帮助你实现文档管理的自动化操作，大幅提升团队协作效率。🤖

📋 为什么需要API接口？

在现代工作流程中，手动管理文档不仅耗时耗力，还容易出错。通过MrDoc的API接口，你可以：

自动化文档同步：将其他系统的文档自动导入到MrDoc
批量操作：一次性创建、更新或删除多个文档
集成第三方工具：与项目管理、自动化工具无缝对接
定制化工作流：根据团队需求构建专属的文档管理流程

🔑 快速入门：API认证与配置

获取访问令牌（Token）

MrDoc API使用Token进行身份验证。首先需要在系统中生成API访问令牌：

登录MrDoc系统
进入API管理界面
创建新的API令牌

每个API请求都需要在请求头中包含Token：

Authorization: Token your_api_token_here

API基础路径

MrDoc的API接口位于/api_app/路径下，主要接口模块位于 app_api/ 目录中。

🚀 核心API接口详解

1. 用户认证接口

登录接口-POST /api_app/login/

功能：获取API访问令牌
参数：username, password
返回：用户信息和Token

2. 文集管理接口

文集列表-GET /api_app/projects/

功能：获取用户可访问的所有文集
支持参数：分页、搜索、排序
相关源码：app_api/views_app.py#L102

文集详情-GET /api_app/projects/{id}/

功能：获取指定文集的详细信息
返回：文集基础信息、文档数量、创建者等

3. 文档操作接口

文档列表-GET /api_app/docs/

功能：获取文集下的所有文档
支持参数：文集ID、搜索关键词、分页
相关源码：app_api/views_app.py#L432

MrDoc文档列表界面，API可以批量获取这些文档信息

创建文档-POST /api_app/docs/

功能：创建新文档
必需参数：title, content, top_doc（文集ID）
可选参数：parent_doc（上级文档ID）、editor_mode（编辑器模式）

更新文档-PUT /api_app/docs/{id}/

功能：更新现有文档内容
支持部分更新和完全替换

4. 图片与附件管理

图片上传-POST /api_app/images/

功能：上传图片到系统
支持格式：JPG、PNG、GIF等
返回：图片URL和存储路径

附件管理-POST /api_app/attachments/

功能：上传和管理文档附件
支持：文件上传、删除、列表查询

5. 文档模板接口

模板列表-GET /api_app/doctemps/

功能：获取文档模板列表
用途：快速创建标准化文档
相关源码：app_api/views_app.py#L628

🔧 实战示例：自动化文档同步

下面是一个使用Python脚本自动同步文档到MrDoc的示例：

import requests import json class MrDocAPI: def __init__(self, base_url, token): self.base_url = base_url self.headers = { 'Authorization': f'Token {token}', 'Content-Type': 'application/json' } def create_document(self, project_id, title, content): """创建新文档""" url = f"{self.base_url}/api_app/docs/" data = { 'title': title, 'content': content, 'top_doc': project_id } response = requests.post(url, headers=self.headers, json=data) return response.json() def update_document(self, doc_id, content): """更新现有文档""" url = f"{self.base_url}/api_app/docs/{doc_id}/" data = {'content': content} response = requests.put(url, headers=self.headers, json=data) return response.json() def get_project_docs(self, project_id): """获取文集下的所有文档""" url = f"{self.base_url}/api_app/docs/" params = {'top_doc': project_id} response = requests.get(url, headers=self.headers, params=params) return response.json()

MrDoc新建文档界面，API可以自动化完成文档创建和编辑

📊 API响应格式与错误处理

标准响应格式

所有API接口都返回统一的JSON格式：

{ "code": 0, "data": {...}, "msg": "操作成功" }

状态码说明

状态码	含义	说明
0	成功	操作执行成功
1	资源未找到	请求的资源不存在
2	无权访问	没有访问权限
3	需要访问码	需要验证码或访问码
4	系统异常	服务器内部错误
5	参数不正确	请求参数有误
6	需要登录	用户未登录或Token无效