API文档经常使用于帮助项目内成员协做、测试,或提供给用户参考使用。如何才可以优雅的分享API文档,使用工具是一个不错的选择。
在线的API文档工具备不少,例如:Swagger、SosoAPI、Eolinker、Showdoc等,目前工做上使用的是Eolinker。
在Eolinker中,您能够在线分享项目给团队之外的人,其余人能够经过分享连接在线查看API文档而且进行API测试。经过这种方式查看API文档不须要注册帐号,方便查看接口文档和测试接口。
进入API管理项目概况页面,点击在线分享项目设置,便可启用或禁用项目在线分享功能。
工具
能够随时开启关闭,分享后,支持不用登陆就能方便地提供给想分享的人查看。若是须要访问支持设置密码,能够按照下图所示设置:
测试
还能够设定容许访客执行的操做:查阅API文档、进行API测试、查看状态码文档、查看项目文档等。如:
能够查看【详细的API文档】、【发起API测试】、【查看Mock API】、【查看状态码文档】、【查看项目文档】,还能够查看【项目环境】的信息。
3d
查看API文档:
blog
发起API 测试:
随时对API发起测试,检测API
接口
查看mock:
展现各类指望、模拟实际返回数据
图片
状态码文档:
注明各类返回状态码的意思
开发
切换环境:
开启以后可查看项目环境,访客能够在项目分享页右上方看到环境切换菜单。
设置访客可以看到的项目环境信息,好比开发环境、测试环境、生产环境等请求地址前缀信息等,默认为不可切换环境。
文档
项目文档:
附带项目的各类文字描述、图片、文件等
get
API工具提升了项目的灵活性,选择合适的API管理工具能够帮助咱们更好的管理项目流程。
Eolinker:www.eolinker.com登录