API在线文档

API文档常用于帮助项目内成员协作、测试,或提供给用户参考使用。如何才能够优雅的分享API文档,使用工具是一个不错的选择。 在线的API文档工具有很多,例如:Swagger、SosoAPI、Eolinker、Showdoc等,目前工作上使用的是Eolinker。 在Eolinker中,您可以在线分享项目给团队以外的人,其他人可以通过分享链接在线查看API文档并且进行API测试。通过这种方式查看API文档不需要注册账号,方便查看接口文档和测试接口。 进入API管理项目概况页面,点击在线分享项目设置,即可启用或禁用项目在线分享功能。 API在线文档_第1张图片

可以随时开启关闭,分享后,支持不用登录就能方便地提供给想分享的人查看。如果需要访问支持设置密码,可以按照下图所示设置: API在线文档_第2张图片

API在线文档_第3张图片

还可以设定允许访客执行的操作:查阅API文档、进行API测试、查看状态码文档、查看项目文档等。如: 可以查看【详细的API文档】、【发起API测试】、【查看Mock API】、【查看状态码文档】、【查看项目文档】,还可以查看【项目环境】的信息。 API在线文档_第4张图片

查看API文档: API在线文档_第5张图片

发起API 测试: 随时对API发起测试,检测API API在线文档_第6张图片

查看mock: 展示各种期望、模拟实际返回数据 API在线文档_第7张图片

状态码文档: 注明各种返回状态码的意思 API在线文档_第8张图片

切换环境: 开启之后可查看项目环境,访客可以在项目分享页右上方看到环境切换菜单。 设置访客能够看到的项目环境信息,比如开发环境、测试环境、生产环境等请求地址前缀信息等,默认为不可切换环境。 API在线文档_第9张图片

项目文档: 附带项目的各种文字描述、图片、文件等 API在线文档_第10张图片

API工具提高了项目的灵活性,选择合适的API管理工具可以帮助我们更好的管理项目流程。 Eolinker:www.eolinker.com

你可能感兴趣的:(API在线文档)