因为最近阿粉一直在做接口开发，前后端分离的项目，阿粉在之前也看过关于swagger，但是阿粉没有用，毕竟弄这个东西，还需要leader批示，加出问题来了，还容易背锅，于是阿粉就开始找能够快速生成接口文档的工具，终于，阿粉成功找到了一个比postman还要好用的工具，即可以做接口的测试，还能生成接口文档。

Run-Api

runapi是一个以接口为核心的开发测试工具（功能上类似一个简化版的postman）。目前有客户端版(推荐，支持win和mac平台）和在线精简版 ，包含接口测试/项目协作等功能。

它和showdoc( https://www.showdoc.com.cn/help)相辅相成：showdoc以文档为核心，侧重文档编写和知识资料沉淀。而runapi则以接口为核心，包含接口测试、管理等一系列功能。同时它将自动生成文档到showdoc。

Run-Api怎么用

首先我们先下载这个软件，

官网，官方防止给大家放上了，大家可以去下载一下，我们现在就来看看他是怎么用的。

Run-Api接口测试

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-VJNyE9lD-1618539221315)(664D3815AE544889BEB825215DDBB697)]

大家安装完后就是这个样子了，我们怎么去掉用接口呢？

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-MNbO2fEz-1618539221317)(266BE56B836D44E18BE9990605F638C1)]

先创建个默认的项目，然后给起一个比较酷炫的名字，

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9B4SH8NA-1618539221318)(5B133EAA0EB343018A0F2D278C02C003)]

然后再这里选择你想要把地址写在哪个项目中，

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xlzYmVbN-1618539221319)(65E01E4CC2934EBBA54B189F93A71EC3)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-umZxgpWM-1618539221320)(630EF3CC8A844D59AFAC993EC99D5C8C)]

大家看，是不是和postman的测试是一样的，况且，postman你还需要去找指定版本，有时候还会导致你系统卡死，但是因为是公认的好用的，所以很多人都直接选择使用postman，但是现在找到了更好的，大家是不是就可以开始换一下了？

假如你们的项目有增加安全机制，那么在请求的Headers中肯定也加入了一些必须要给的参数，比如Token，如果你在每个接口里面都需要这个Token 的话，你还要给每个接口都加，那多麻烦，来配置个全局的参数变量吧，看下图所示

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Cd6eSJcw-1618539221321)(7CEF6BEBEB2F4A319C972520DF5F2253)]

大家进入官网之后，忽然看到了个本地/局域网，这是个啥呢？

官网简介：如果你是使用runapi客户端（https://www.showdoc.cc/runapi),则会自动跨域，可以请求本地和局域网的接口，不需要用户额外操作。但如果你是使用在线精简版（ http://runapi.showdoc.cc ）则需要在API的服务器上设置允许跨域。在服务器返回API结果的时候，也顺便返回三个允许跨域的http header，其结构如下：

Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials : true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Connection, User-Agent, Cookie

大家注意看，如果你直接使用在线版本，那么你需要关心这个，如果你像阿粉一样，直接使用客户端，那么恭喜你，这一步，你可以压根就不用管，因为官网告诉我们了，他可以自己跨域，是不是很爽？

Run-Api如何生成接口文档

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-AOF1Goyi-1618539221322)(F9E6E66A52C54CEF9AD99CC6054C33D0)]

我们把我们想要的信息都设置完成之后，然后点击发送，等待结果出现，这时候我们就要点击保存了。

保存完成之后，它会根据你设置的入参还有出参，给你生成文档，

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Sm7qNMFx-1618539221322)(AE56C445EABB49E480328A57680B7634)]

上图是入参，文档图在这里，来了

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-lKGExVj2-1618539221323)(6811B4415D174E03B8F7B0F75649EAD2)]

同时它会给你一个密码，只有你们两个人知道呦，这样我们就打开网址来看看，这个接口文档是什么样子的，有没有大家想象中的那么简单易懂。

入参实例：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-43Fo83AP-1618539221323)(014ED9C6F4454077B8C6878E77E588F0)]

出参实例：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-pXV6z3m7-1618539221324)(6EB42557628F4A03B93A2A06C4D4135B)]

看是不是有点牛，而且样子还是非常美观的，也不需要去像Swagger一样，去给方法里面加注解，而如果你对Swagger不是特别熟练，有时候还会忘记，但是这样生成了，给前端的网址，然后让他们自己去调用接口就可以了，是不是很爽，又安利了一款软件。

如果大家需要，请在公众号后台回复runapi，连接地址发给大家，直接下载即可使用，你还在等什么呢？

对比postman

我们再来看看传统的postman，英文比较多，

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-2lIe4d3L-1618539221325)(AE4EBCF229EE43A1A6E352A0A21B5B9F)]

GET请求：点击Params，输入参数及value，可输入多个，即时显示在URL链接上，
所以，GET请求的请求头与请求参数如在接口文档中无特别声明时，可以不填。

POST请求：传递参数params，Json格式的就行，然后再发送请求就可以，阿粉认为，毕竟很多人都在用postman，但是哪个好用，哪个不好用，这个还是分人，就比如有人喜欢牛奶，有人喜欢可乐，有人喜欢果汁一样。

所以，选择什么软件，大家就用什么软件，没有必要强求不是，到现在阿粉公司都是IDEA和Eclipse共存，使用习惯不一样，就是不一样，所以，大家看着选择吧。