YApi搭建流程

2021-01-07 18:27

阅读:473

  • Swagger是通过在代码中写注释或者引入文件来自动生成API文档,要去学习Swagger的文档语言,不是可视化的操作。

  • Postman是API接口设计测试神器,但是他们的API文档只能通过网页来保存与查看,并且他们的response不支持参数的注释介绍,也就是只有返回结果,但是不能自定义每个返回参数的含义,除非单独在json结果中添加注释。

  • ApiPost是国人开发的,功能和PostMan很类似,是我使用最久的,虽然软件内还有一些小问题,但是对于Postman以上两点有极大的改善,不仅文档能导出Markdown和word,并且response的结果可以自动导出键值对并且对其进行注释。不过在使用了几个月后让我放弃的原因就是安全问题,他们的隐私政策中并未提到是如何保存我的接口数据的,并且我如果要生成文档,就一定要分享接口或者目录,这个分享链接默认是开放的,类似于Postman的publish document,但是Postman可以只在团队中分享,并且分享是很严格需要确定的,然而ApiPost的分享只要点击一下,我的这个接口就开放了,我如果没有及时关闭,我甚至都找不到我以往分享了哪一些接口,其实这些不能算是严格的安全问题,最重要的是ApiPost团队可以不经过我的允许查看我的所有接口数据(这是亲身实践确定,这一点就说明了我在他们的数据库数据完全是未加密的,因为我习惯在设计API时也将设计文档写在一起方便查看,但如果是明文数据,那么我还是很排斥的,所以在这之后我就选择了大团队或开源软件以保证我数据的安全性)

  • Rap2界面难受


评论


亲,登录后才可以留言!