接口空间 分享链接 /book/zentaopms/1040.html?releaseID=17

【18.4版本起】文档中新增接口空间，可以在接口空间中创建某项目或产品下的接口文档，也可以在接口空间查看对应项目或产品下的的接口库和接口文档。也可以在接口空间中管理接口库和文档、数据结构、版本管理及发布接口。

【21.1版本起】在接口空间中新增了首页，在接口空间首页中可以查看独立接口库、产品接口和项目接口。进入库或项目/产品后可以查看库下的数据结构、接口版本、目录和文档。

接下来我们来具体介绍接口空间如何使用

一、分配权限

1、空间的浏览权限

文档接口相关权限均可在这里完成维护。

2、空间的操作权限

在后台--人员管理--权限--接口管理--创建与维护接口中分配对应的权限，权限分配可以灵活按照实际工作需要来分配。
文档接口相关权限均可在这里完成维护。

二、维护空间首页【20.8版本起】

1、查看空间首页

点击二级导航接口空间，进入接口空间首页，在这里默认选中独立接口，切换到产品接口或者项目接口，可以查看产品下的接口库和项目下的接口库。

2、查看库和文档

在首页点击某个库、产品或项目，可以查看其下的文档。

三、维护接口库【15.7版本起】

1、创建接口库

点击接口库--文档页面右上角的创建按钮，即可进入接口库创建页面。

创建接口库页面可以设置请求基路经，接口库的访问控制。

接口库创建成功后，可以在左上角的接口库下拉组件里查看到。
创建接口库成功后，我们就可以对接口库进行目录、版本管理、编辑和删除接口库操作。

2、维护接口库目录

按照使用需要添加接口库的目录后，点击保存即可。

再次进入维护目录页面，可以对目录进行排序，编辑删除，添加子目录的操作。

3、编辑和删除接口库

编辑接口库页面：

删除接口库的确认页面：

四、维护接口库【18.4版本起】

1、创建接口库

点击文档--接口空间--创建库的按钮，可以创建接口库。

在创建库的弹窗中，可设置请求基础路经、接口库的访问控制。支持创建独立接口库、产品接口库以及项目接口库。

选择私有权限后，可设置白名单用户。

接口库创建成功后，可以在左上角的接口库下拉组件里查看到。
创建接口库成功后，我们就可以对接口库进行目录、版本管理、编辑和删除接口库操作。

2、查看某产品或某项目下的接口库或文档

可选择产品或项目，查看其下的接口库和文档。

3、维护接口库目录

鼠标悬浮到某接口库上，点击右侧出现的更多按钮，可添加目录、编辑库和删除库。

鼠标悬浮到某接口库下文档时，点击右侧出现的更多按钮，可添加同级目录、添加子目录、编辑目录和删除目录。

编辑接口库：点击下拉菜单中的编辑接口库和编辑目录按钮。

删除接口库：点击下拉菜单中的删除接口库和删除目录按钮。
删除接口库和删除目录会出现二次确认的弹窗

五、维护库【21.1版本起】

1、创建库

在接口空间首页中，选择独立接口Tab项，点击创建库按钮，可以创建独立接口库。选择产品接口/项目接口Tab项，点击创建库按钮，可以在产品或项目下创建接口库。

进入文档列表页中，点击创建按钮，也可以在这里创建库。

在创建库的弹窗中，可以选择接口库类型，在对应的产品/项目下创建创建库。

注：库的访问权限默认设置为公开，可以选择默认权限或私有权限，私有权限支持设置白名单用户。

2、查看库

在空间首页，可以查看独立接口库及文档的数量。当切换到产品接口/项目接口类型下后，可以查看所属项目集下的产品/项目。

进入库后，可以在左上角路径导航中切换三种类型，查看独立接口库、产品接口库或项目接口库。

六、维护目录【21.1版本起】

1、创建目录

当库下没有目录和文档时，左侧目录导航为空。可以点击添加目录按钮，添加新目录。

当库下已有文档时，在底部设置按钮中，可以点击添加目录按钮，添加新目录。

当已有一个目录时，在目录的右侧更多按钮中，添加同级目录或子目录。

2、维护目录

在目录的右侧更多按钮中，可以编辑目录或删除目录。

编辑目录时，可以更改所属库和上级目录。

七、维护接口

维护好接口库的目录后，我们就可以添加接口库文档了。

1、创建接口

点击文档--接口空间--创建接口的按钮，可以创建接口文档。

当接口库下没有接口文档时，也可在页面中点击创建接口按钮。

在创建接口页面中，可填写内容如下：
所属接口库：默认不可更改
目录：可在下拉菜单中选择所属接口库的目录
请求路径：目前支持 HTTP、HTTPS、WS和WSS , GET、POST、PUT、DELETE、PACTH、OPTIONS、HEAD
请求格式：application/json , application/x-www-form-urluncoded ,multipart/form-data
开发状态：开发完成、开发中、不显示
负责人：负责该接口的人员
请求头：接口的请求头字段
请求参数：接口的请求参数字段

请求体：有4种类型：FormData,JSON,Array,Object
选择了类型后，可以根据类型填写字段名、字段类型、是否必填、描述。

以及给字段添加子字段，对字段、子字段进行添加和删除操作。

请求示例：根据请求体，给出一个请求示例。

请求响应：填写该接口的响应字段、字段类型、是否必填、描述、添加子字段等操作。

响应示例：根据接口的请求响应字段，编写一个响应示例。
描述：对接口的简要介绍。

填写完接口的信息，点击保存，即可在接口列表查看到添加成功的接口。
可以查看接口的开发状态，请求路径。

2、编辑接口

接口列表详情中，点击右上角的编辑按钮，进入编辑接口页面。

编辑接口页面：
需要注意的是，编辑接口不能更改所属的接口库。

3、全屏和删除接口

点击删除按钮，可以删除接口，需二次确认。

八、发布接口

创建接口发布版本：

发布接口成功后，可以切换版本来查看接口文档。

九、版本管理

点击版本管理按钮，可以对接口文档进行版本管理，查看已发布的版本和删除不需要的版本。

十、维护数据结构

点击数据结构按钮，进入数据结构列表页面。

在数据结构列表页，可以创建数据结构。

在创建数据结构页面，填写数据结构的名称，类型和字段和描述即可。

创建成功的数据结构在数据结构列表里显示，可查看、编辑和删除。

十一、导出文档

点击页面右上方的导出按钮，可以选择导出范围是「列表中接口文档」或者「未关联产品和项目的所有接口文档」，文档类型为word，编码为UTF-8，导出格式仅支持导出为合并为一个文档。