跳到主要内容

组件库

视频内容

组件库用于管理当前项目的所有响应组件,包括响应组件的创建、编辑、删除和分组等功能。

迁移通告

原“公共响应”现已迁移至“组件库” → “响应组件”。你可以在响应示例中更加方便的引用公共响应组件。

创建响应组件

响应组件主要面向接口文档设计场景。通常情况下,一个接口的响应示例分为成功示例与失败示例两种类型。即使失败示例中的状态码可能存在差异,但返回的响应数据结构通常是一致的,因此可以将其抽离出来作为公共的响应组件并纳入统一管理,以便能够在其它接口文档中更加方便的引用。

点击响应组件右侧的 + 号,点击「新建响应组件」按钮。

编辑响应组件

填写响应组件的状态码、填写响应的名称和指定内容格式。响应组件内的数据结构支持通过 JSONXMLJSON SchemaMySQL DDLMockjs 等多种格式进行导入;或者引用项目内已有的数据模型完成数据结构的编写。

你可以将一些使用频率较高的公共响应组件(例如 404 错误)设置为默认响应组件。新建接口时将在「返回响应」中自动添加该公共响应组件,无需频繁手动添加。设为「默认添加状态」的响应组件将在目录树栏内的右侧出现打勾标记。

使用响应组件

在接口文档中,点击返回响应右侧的 + 号,在「引用响应组件」栏中选择需要引用的响应组件即可完成添加。

若你需要单独针对某个接口的响应组件进行自定义调整,需要点击右侧的 ··· 按钮,轻点「解绑」后即可单独调整。

编辑默认响应模板

设定默认响应模板后,新建接口时,接口文档内的响应组件将自动应用该默认模板。点击左侧菜单树内的“默认响应模板”选项进行设置,你可以在此处调整 HTTP 状态码和响应内容格式,同时引用数据模型。

仅支持添加一个默认响应模板,无法添加或删除模板。修改模板后不会影响已创建的接口,但会影响未来新建的接口。

点击右上角的“保存”后,在当前项目内新建接口时,接口文档内的「返回响应」栏将添加响应模板中的预设内容。