# 概述

文档集是由一个或多个接口文档组成的文档集合。每个文档集都会生成一个唯一访问地址,通过该地址对文档集进行单独访问、效果预览。也可以根据需要,将其文档集嵌入到相应的项目中。如何将其快速集成到系统中,可参考下一节的 "开放文档快速集成" 。

# 文档集列表

菜单位置:文档管理 > 文档集。点击菜单后进入文档集列表页面,如图所示。
manager_interface_collection_list_query

# 新增文档集

点击 新增 按钮打开新增页面,如图所示。新增文档集页面,包含内容:

  • 名称:文档集名称,必填。
  • 描述:文档集描述。
  • 服务:对应于接口文档列表数据,必填,可多选。 manager_interface_collection_add_1 manager_interface_collection_add_2

# 编辑文档集

点击 编辑 按钮打开编辑页面,如图所示。 manager_interface_collection_edit_1 manager_interface_collection_edit_2

# 删除文档集

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

# 预览文档

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

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

manager_interface_collection_preview_2

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

# 复制文档集地址

点击 复制地址 按钮,可以复制文档集的访问地址到粘贴板,如图所示: manager_interface_collection_copy

上次更新: 2021-9-10 14:29