Apikit 自学日记:分享 API 文档

开启/关闭在线分享

您可以在线分享项目给团队以外的人,其他人可以通过分享链接在线查看API文档并且进行API测试。通过这种方式查看API文档不需要注册账号,用户可方便查看接口文档和测试接口。

在项目内,点击进入项目管理菜单,选择 在线分享,即可启用或禁用项目在线分享功能。

进入点击 项目页面顶部的 分享项目 按钮,亦可启用或禁用项目在线分享功能。

设置访问密码

默认无需密码访问项目,开启需要密码访问后,系统会默认提供6位数密码,密码包含数字和字母。

用户可自定义密码,输入密码并输入框失焦后会自动保存新密码。外部人员下次访问页面时需要输入新密码才可访问。

设置访客可进行的操作

可设置分享项目可见页面,用于控制外部人员通过链接访问时可查看的项目页面,系统默认可见全部。全部页面包含:API文档页、API测试页、API测试用例页、状态码文档页、高级Mock页、项目文档页。其中API文档页是必选,必定会对外展示。

设置访客可查看的项目环境

可设置项目环境权限,用于控制外部人员可用的测试环境,系统默认可选全部项目内的环境。注意仅包含该项目内创建的环境,不会包含应用级的公共环境。

开启之后,访客可以在项目分享页右上方看到环境切换菜单。


设置API文档范围

可设置分享范围,用于控制外部人员可查看的API文档范围,系统默认可查看项目内所有API。用户可进行逐一勾选。系统默认分享所有API

你可能感兴趣的:(Apikit 自学日记:分享 API 文档)