文档服务器常见问题解答:
一般问题

全部展开

全部折叠

我是文档服务器 API 的新手。我应该从哪里开始?

如果您不知道从哪里开始使用文档服务器API,我们建议您先阅读 基本概念它是如何运作的 部分,以便更好地了解文档服务器API的构建方式。熟悉主要概念后,您可以访问 立即尝试 部分,查看实际使用的文档服务器主要功能示例。

如果您对特定的编程语言示例感兴趣,请参阅 特定于语言的示例,它们是以多种编程语言编写,解释了如何安装文档服务器、从何处获取示例源文件以及如何安装它们和连接文档服务器。

对于使用某些文档管理系统(Nextcloud、ownCloud、SharePoint 等)、并且只是想知道如何将文档服务器连接到这些系统的用户,应该访问 即用型连接器 部分,在那里所有与文档服务器一起使用的主要插件都有解释。

每个API方法的详细描述可在更大的 文档 模块中找到。所有方法都在相应的部分中描述,它们的列表在 高级参数部分中可以找到。

如何查看文档服务器的当前版本号?

当前的文档服务器版本号可在文档编辑器、演示文稿编辑器或电子表格编辑器的 关于 页面上找到,位于徽标和编辑器名称的正下方。

您可以使用 API 向 文档命令服务发送 POST 请求。将 c 参数的值设为 "version" ,在请求正文中作为 JSON 对象发送:

{
    "c": "version"
}

版本的请求结果以 JSON 形式返回,如下所示:

{
    "error": 0,
    "version": "4.3.1.4"
}

有关与 文档命令服务 交互以及使用各种命令执行此操作的更多详细信息,请访问 此页面

我想从 default.json 配置文件中更改一些文档服务器参数。我该怎么做才能使我的更改在更新后不会丢失?

文档服务器的所有主要设置都存储在 default.json 配置文件中,该文件位于 /etc/onlyoffice/documentserver /文件夹(适用于 Linux)或 %ProgramFiles%\ONLYOFFICE\DocumentServer\config\ (适用于 Windows)中。在同一文件夹中还有特定于平台的 production.json 文件,其中存储了与 Linux 或 Windows 相关的设置。

文档服务器使用 Node.js 配置模块 来组织和构造配置文件,因此这些文件的层次结构如下所示:

default.json
production.json
local.json

所有主要设置都存储在 default.json 文件中,其中一些设置被 production.json 文件中的设置添加或覆盖,任何用户/开发人员设置被 local.json 配置文件中的设置覆盖。

如果您更改 default.jsonproduction.json 文件中的参数,所有更改将在 文档服务器更新或 Docker 容器重启后丢失(如果您使用 Docker 安装了 文档服务器)。

因此,我们强烈建议您 不要 更改 default.jsonproduction.json 文件中的参数,而是使用 local.json 配置文件。此文件必须与 default.json 文件在同一文件夹中创建,并且 必须保留 必要参数的 整个对象结构

local.json 的使用示例可以在以下部分中找到: