本文转载自微信公众号《Java极客技术》,作者鸭血范。转载本文请联系Java极客技术公众号。因为阿凡最近在做界面开发,前后端分离的项目,之前阿凡也看过swagger,但是阿凡没用。毕竟,想要得到这东西,还是需要领导的认可。添加问题很容易。当年,阿芬开始寻找一款可以快速生成接口文档的工具。终于,阿芬成功找到了一个比postman还好用的工具,可以测试接口,生成接口文档。Run-Apirunapi是一款以接口为核心的开发测试工具(功能上类似于简化版的postman)。目前有客户端版(推荐,支持win和mac平台)和在线精简版,包括界面测试/项目协作等功能。与showdoc(https://www.showdoc.com.cn/help)相辅相成:showdoc以文档为核心,专注于文档编写和知识积累。runapi以接口为核心,包括接口测试、管理等一系列功能。同时它会自动生成文档到showdoc。Run-Api的使用方法首先我们先来下载这个软件,官网,官方给大家预防了,大家可以下载,看看现在是怎么用的。安装后的Run-Api接口测试是这样的。我们如何删除接口?先创建一个default项目,然后给它取个酷炫的名字,然后这里选择你要写地址的项目中,大家看看测试是不是和postman一样。另外,你需要找到指定版本的postman,有时会导致你的系统卡顿,但因为公认好用,所以用的人多。选择直接使用postman,但是既然找到了更好的,是不是可以开始改了呢?如果你的项目添加了安全机制,那么你还必须在请求的headers中添加一些必须要给的参数,比如Token,如果你在每个接口都需要这个Token,就得在每个接口中添加。多麻烦,我们配置一个全局参数变量吧。如下图,进入官网后,突然看到一个本地/局域网,这是什么?官网介绍:如果使用runapi客户端(https://www.showdoc.cc/runapi),会自动跨域,可以请求本地和局域网接口,不需要用户额外操作。但是如果你使用的是在线精简版(http://runapi.showdoc.cc),你需要在API服务器上允许跨域设置。服务端在返回API结果时,同时返回三个允许跨域的http头。结构如下:Access-Control-Allow-Origin:*Access-Control-Allow-Credentials:trueAccess-Control-Allow-Headers:Origin,X-Requested-With,Content-Type,Accept,Connection,User-Agent,cookie大家注意,如果你直接使用网络版,那么你需要关心这个,如果你像阿粉一样直接使用客户端,那么恭喜你,你完全可以忽略这一步,因为官网告诉我们的可以自己跨域了,爽不爽?Run-Api是如何生成接口文件的我们把我们想要的信息都设置好之后,然后点击发送,等待结果出现,我们再点击保存。保存后,它会根据你设置的输入参数和输出参数为你生成文档。上图是输入参数,文档图片在这里。当你来的时候,它会给你一个密码,只有你们两个知道。这样,我们打开网址,看看这个接口文档长什么样,是不是像大家想象的那样简单易懂。输入参数示例:输出参数示例:看看是不是有点牛逼,外观还是很漂亮的,而且不需要像Swagger一样在方法上加注解,如果你对Swagger不是特别熟练,有的时候你会忘记,不过就是这样生成的,给前端网址就行了,然后让他们自己调用接口,是不是很酷,安利另外一个软件。需要的请在公众号后台回复runapi,将连接地址发给大家,下载后直接使用即可。你在等什么?与postman相比,我们来看看传统的postman,它的英文比较多。GET请求:点击Params,输入参数和值,可输入多个输入参数,并立即显示在URL链接上。所以如果GET请求的请求头和请求参数在接口文档中没有特别声明,可以留空。POST请求:传递参数params,Json格式即可,然后发送请求,阿芬相信毕竟很多人都在用postman,只是哪个好用哪个不好用,这个是还是分人的,比如有人喜欢牛奶,有人喜欢可乐,有人喜欢果汁。因此,您可以使用您选择的任何软件。没有必要坚持它不是。到现在,阿芬公司IDEA和Eclipse并存。使用习惯不同,但又各有千秋。因此,每个人都选择。
