yapi接口导出为word_使用Yapi展示你的api接口

今天研究了下一款非常好用的api集中展示工具---Yapi,具体网址 https://hellosean1025.github.io/yapi/documents/index.html

它的作用是帮你智能的展示你的项目里的所有接口,还可以提示接口是开发完成还是未完成,这样就非常方便一些前后端分离的工作,前端人员可以直接通过查看哪些接口是“已完成”的,

就可以放心的调用,后端人员如果发现接口有异常,也可以改为“未完成”状态提示前端不要使用,它还包括调用参数的个数及类型,但是你需要在接口里面写好注释。

先上几张图给大家看一下样子,有个直观的了解

可以看到第一张图中,Yapi很清晰完整的展示了所有我们开发的接口,然后还有一个完成状态,从第二张图中,我们也可以知道调用接口需要传什么参数,返回的是什么参数等等,功能非常完善。

那么我们如何把它弄到本地呢,查看官网教程,如下图

可以看到,使用Yapi,需要安装好mongodb(2.6+)和nodejs(7.6+),安装之后,打开命令行直接输入 npm install -g yapi-cli --registry https://registry.npm.taobao.org yapi server 来安装yapi

然后根据页面提示选择yapi的版本等信息,最后点击部署,就部署成功了,这里另外提一下ÿ

你可能感兴趣的:(yapi接口导出为word)