API设计-保存并预览文档

提示

🔥🔥🔥Tips：您同样可以在 API调试 模块快速调试接口并一键生成文档，如果不需要Mock，无需在 API设计 模块预先定义。

我们在API设计模块所设置的内容，可以自动生成一篇文档以交付给前端，该文档包含了接口信息、请求参数、响应示例的所有内容。

响应示例：

1、生成示例：生成的文档默认不展示响应示例，我们可以通过点击 “生成全部示例” 按钮，生成所有已有期望所对应的响应示例，并自动提取其字段描述。

2、更新示例：点击每个响应示例右侧的“更新”按钮，则会更新为最新的响应示例。

编辑文档：支持在预览文档的代码框中编辑示列，点击“保存”按钮后生效。

分享文档：点击【分享文档】按钮后，我们可以设置分享的有效期和权限，并将该文档分享给他人。