概述

对接口模块进行建档管理，一个接口文档可能包含多个接口模块，每个接口模块亦可包含多条接口。在文档模块中，可以详细查看每个接口的基础信息，如请求地址、请求参数、响应参数、响应结果等。同时还可以控制每个接口的展示情况，是否附带认证信息，是否允许调试等情况。

接口文档列表

菜单位置：文档管理 > 接口文档。点击菜单后进入接口文档列表页面，如图所示。

新增接口文档

点击 新增 按钮打开新增页面，如图所示。

点击“新增环境”信息按钮，可以快速进行环境信息新增操作。

其中，新增文档页面包含两部分内容： 基础信息和接口信息部分。
（1）基础信息包含内容如：

• 名称：文档名称，必填。
• 描述：文档描述。
• 版本：文档版本，必填。
• 认证信息：单选下拉框，其数据来源于认证信息管理列表。
• 请求地址：多选下拉框，其数据来源于请求地址管理列表，必填。
• 文档来源：有三中类型，如：服务、API、Local，必填。

当文档来源为 "服务" 时候，需选择 服务 + 输入地址，点击 "获取" 按钮，获取接口信息

当文档来源为 "API" 时候，需输入完整的 API 地址，点击 "获取" 按钮，获取接口信息

当文档来源为 "LOCAL" 时，可将 符合 swagger json 格式的接口数据，复制到文本框里，点击 "加载" 按钮，获取接口信息

（2）接口信息：
接口信息部分，每个模块下会包含一个或多个接口。点击左侧的树节点，查看每个接口具体信息情况，包括：请求信息、接口描述、请求参数、响应状态、响应参数、响应示例。 同时可控制每条接口的是否展示、是否包含认证信息、是否允许调试和添加备注。

编辑接口文档

点击 编辑 按钮打开编辑页面，如图所示。
注意：保存时后端判断 版本 字段是否发生变更，发生变更时记录快照，通过 历史版本 可查看该快照。

删除接口文档

点击 删除 按钮弹出删除确认窗口，如图所示。

预览接口文档

点击 预览 按钮打开预览页面，如图所示。
预览页面包含两部分： 接口基本信息、调试

接口信息包含了接口地址、接口描述、请求参数、响应状态、响应参数等信息。

调试部分，可进行接口调试。这里，可以选择接口所属环境，如开发环境、测试环境等。同时可以修改请求参数、编辑请求地址等信息。点击"发送按钮”，便可以进行接口请求，并查看接口响应情况。

历史版本列表

点击 历史版本 按钮打开历史版本页面，如图所示。

历史版本页面，可以查看对应接口文档的历史记录，同时允许对历史版本进行预览和删除功能。

删除历史版本

点击 删除 按钮弹出删除确认窗口，如图所示。

预览历史版本

点击 预览 按钮打开预览页面，如图所示。
预览页面包含两部分： 接口基本信息、调试

接口基本信息包含了接口地址、接口描述、请求参数、响应状态、响应参数等信息。

调试部分，可进行接口调试。这里，可以选择接口所属环境，如开发环境、测试环境等。同时可以修改请求参数、编辑请求地址等信息。点击"发送按钮”，便可以进行接口请求，并查看接口响应情况。