一个漂亮的 API 文档生成工具
前言
今天加班肝到太晚了,没精力整理要分享的东西了,就来点现成的东西吧(不水文,这个真心有用)。有时候我们需要一个漂亮,完整又好用的 api 文档界面,而 Swagger(我一直用的是这个~)默认的风格又有点鸡肋~~欸,这时候这个工具就派上用场了,这就是 ApiFox!
使用
选择使用环境
ApiFox 感觉像是 Postman 的国产增强版,提供了 web 版和桌面版,而且这个桌面版是全平台的奥~
估计是用到了 Electron 之类的全平台框架。
选一个合适自己的环境就好。
注册账号
这个不太需要说了吧~~最好是绑定下微信,比较方便
创建团队
ApiFox 的涉及理念还是以团队为起点的,也就是不管你团队是一个光杆司令,还是 Two-Pizza Team 或者 X-Pizza Team,都得先创建一个团队,创建好后,就可以建立接口文档项目了
编写接口文档?
为啥加个问号呢?因为咱用 ApiFox 可不是为的从头开始写自己的接口文档,当然如果你愿意这样做也是绝对没问题的。但这可没办法突出 ApiFox 的厉害之处,我们用它当然是导入已有的接口文档,来达到增强和美化的目的。
这里呢,ApiFox 提供了多种格式的导入模式,首选的就是 Swagger,也支持其他格式,甚至其他接口测试工具的格式(方便你把在 Postman 之类的工具保存的接口记录迁移过来~~真是个小机灵鬼)
所以,这里我们就直接把已有的 Swagger 文档导入过来就行了。注意这里支持直接导入 json 文件,也支持通过 url 方式的形式导入,也就是如果你的接口文档已经部署上线了,可以直接通过 url 指向的 json 文件导入到 ApiFox 里,整个过程,非常丝滑,具体过程可以参见官方指南。
来看下导入前后的界面对比
普通的 Swagger 首页就是这样,也不丑,也不好看,也不难用,也不好用,中规中矩,普普通通(注意,这可不是在贬低 swagger,swagger 还是一个非常伟大的框架的,我在前面也写过几篇介绍 swagger 的东西,这里咱只是单拎出来其中的一小部分来说~~端水大师+1)。
再来看看 ApiFox 帮我们生成的文档
感觉是不是瞬间提升了好几个档次,还能帮你生成访问代码,前端同事表示非常香。
最后,ApiFox 所提供的功能,也远不止我提到的这些,但我提到的这个导入的功能,绝对可以成为吸引你使用它的一个亮点!我也注意到有很多博友全面的介绍过 ApiFoxle ,我感觉大家写的太全面了,亮点太多了,可能对像我这样段位比较低,也没用过 ApiFox 的同学来说,没啥太大的吸引力,甚至可能因为你写的太多以至于让人觉得学习成本太高,就直接忽略了,造成安利失败~~。但好的产品还是自己会发光,更多的使用经验,咱还是去看官方的手册吧。
好了,大概就是这样了。
版权声明: 本文为 InfoQ 作者【为自己带盐】的原创文章。
原文链接:【http://xie.infoq.cn/article/67d6a7ec1efdf8a8fc08c3425】。
本文遵守【CC-BY 4.0】协议,转载请保留原文出处及本版权声明。
评论