在线分享
视频内容
在 API 设计、开发、沟通、协作中,逻辑上应该以团队内共同定义的 API 文档为标准。但实际操作中,团队成员习惯依靠 Word、PDF 格式文件进行 API 文档协作,造成大量信息未能及时同步,将接口以在线形式分享将有助于提高团队之间的沟通效率。
选择接口范围
点击 Apifox 左侧菜单栏的“在线分享”按钮,新建“分享列表”。设置分享对象、分享范围、访问密码、指定运行环境等参数。
开启整目录分享
在线文档支持开启“整目录分享”。若在选择对应的接口分组时打开了整目录分享功能,则在修改该分组后会自动同步至在线文档。如果并不希望在线文档实时同步您的修改,可以取消勾选此功能。
设置完成后复制链接,就可以分享给团队成员了。
查看已分享接口
点击分享列表中的“打开链接”按钮,即可查看已分享的在线接口文档。
支持在在线文档中直接发起调试,同时你还可以便捷复制接口 URL、数据接口字段以及返回示例字段。详细调试方法请参考《在文档中进行调试》。
导出在线文档接口
API 文档的管理员在“发布设置”中开启「允许导出数据」按钮后,任何有权限访问在线文档的用户都可以直接在网页上导出 API 数据。
其他用户打开在线文档链接后,点击右下角的“导出”按钮即可选择以 Apifox
、OpenAPI(Swagger)
、HTML
或 Markdown
导出当前 API 文档。
建议 Apifox 用户可以直接选择“克隆”该 API 文档至自己的项目内。