跳到主要内容

自定义接口字段

”自定义字段“功能允许用户根据自己的需要，在接口文档中新增通用字段，比如：创建时间、TAPD 链接、需求文档链接等，以更加方便的管理项目。

配置自定义字段​

团队管理者可以根据项目需要配置自定义字段。访问”项目设置“中的”功能设置“进行设置。

你可以在自定义字段中填写以下内容：

  1. 字段名：该字段的名称

  2. 字段类型：支持文本、数字、单选、多选、日期、项目成员、链接、邮箱、单选标签、多选标签 （单选、多选支持管理者设置选项）

  3. 提示语：展示给项目成员，填写内容时给予提示

  4. 对应 OpenAPI 字段：导入/导出 OpenAPI/Swagger 格式数据时使用，留空则在导入/导出 OpenAPI/Swagger 格式数据时忽略该字段

  5. 启用：管理者可以根据需要，开启/关闭该自定义字段

填写自定义字段​

管理员配置”自定义字段“并开启后，项目成员可以接口页中按照要求进行填写。

展示自定义字段​

配置”自定义字段“并填写后，接口文档页将展示出对应的信息。