跳到主要内容

预览、分享文档

提示

🔥🔥🔥Tips：可以在tab栏快速分享单个接口文档或者直接在顶部菜单栏快速分享整个项目的接口文档

image.png

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

预览文档​

可以直接在预览页面，预览我们的接口文档，查看接口定义的请求参数、响应期望等参数信息

image.png

分享单接口文档​

直接在接口的页面，点击【分享文档】按钮后，支持设置分享限制，例如密码查看、文档有效期、接口开发环境、接口扩展的属性字段然后将链接分享给他人

image.png

分享目录下的文档​

鼠标悬浮在要分享的目录上，点击更多操作——分享目录 image.png

分享整个项目​

点击顶部菜单栏上的分享项目，分享项目支持自定义项目logo image.png

自定义分享​

创建自定义分享，自定义分享有两个入口 分享弹窗的底部按钮 和 文档分享模块的自定义分享按钮

【入口1】

image.png 【入口2】 image.png

选择要分享的接口或文档，即可分享部分接口

image.png