一款比postman还要好用的测试接口工具，竟然还能生成接口文档？

﹏ヽ暗。殇╰゛Y 2023-01-16 04:52 144阅读 0赞

每天早上七点三十，准时推送干货

![219e104b796250009b8bd7371799623a.png][]

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

#### Run-Api ####

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

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

#### Run-Api怎么用 ####

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

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

#### Run-Api接口测试 ####

![0b6ff712a066b57e2152e14f3b1252f9.png][]

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

![8642d9001498ab11912d9462c4d6f803.png][]

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

![1b3591b2162974e5d7cac5000f62099e.png][]

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

![75b8d570a95548357a2a8b9bd144576a.png][]

![3ca11030f5a2ba161cf57f3ff4775908.png][]

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

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

![529db21e6f1271016631cfaae47d32a9.png][]

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

官网简介：如果你是使用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如何生成接口文档 ####

![9d9e644f3d6d16aeeacff15e25db460a.png][]

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

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

![b12c7fc4ae374a19cbfd637590926a40.png][]

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

![d6282c4fa7c88b01d1f9b9c570097fff.png][]

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

入参实例：

![a670ec98d5c903b63d5bfe6a3457432b.png][]

出参实例：

![9272ea47ebde70acb17c8101070200e8.png][]

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

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

#### 对比postman ####

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

![49d68c42f233b5495230012e31d05837.png][]

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

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

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

## 最后说两句（求关注） ##

**最近大家应该发现微信公众号信息流改版了吧，再也不是按照时间顺序展示了。这就对阿粉这样的坚持的原创小号主，可以说非常打击，阅读量直线下降，正反馈持续减弱。**

所以看完文章，哥哥姐姐们给阿粉来个**在看**吧，让阿粉拥有更加大的动力，写出更好的文章，拒绝白嫖，来点正反馈呗~。

如果想在第一时间收到阿粉的文章，不被公号的信息流影响，那么可以给Java极客技术设为一个**星标**。

最后感谢各位的阅读，才疏学浅，难免存在纰漏，如果你发现错误的地方，留言告诉阿粉，阿粉这么宠你们，肯定会改的~

最后谢谢大家支持~

最最后，重要的事再说一篇~

快来关注我呀~  
快来关注我呀~  
快来关注我呀~

**【号外】Java 极客作者团队招新啦！！！扫码添加鸭血粉丝微信，加入我们，一起进步。**

![1ccb6c01962d04712ec0347f36c4ae31.png][]

[219e104b796250009b8bd7371799623a.png]: /images/20221022/93c9f45bac9842bf93da8f2fc4a8a62c.png
[0b6ff712a066b57e2152e14f3b1252f9.png]: /images/20221022/f4a68043362247d28955647f1ce5d06f.png
[8642d9001498ab11912d9462c4d6f803.png]: /images/20221022/23bff81d9835439d97dae905078e63da.png
[1b3591b2162974e5d7cac5000f62099e.png]: /images/20221022/5bc45ae277c14f4980262a8f7e4b7bdf.png
[75b8d570a95548357a2a8b9bd144576a.png]: /images/20221022/bb0fd5ee972c47188b16df2c44b2b455.png
[3ca11030f5a2ba161cf57f3ff4775908.png]: /images/20221022/430fd31b2d744be88df696c443f0aa62.png
[529db21e6f1271016631cfaae47d32a9.png]: /images/20221022/2767d1486ac54d7c85f9e1da15cf4403.png
[9d9e644f3d6d16aeeacff15e25db460a.png]: /images/20221022/63328a32f0e147bfae16cda7da334496.png
[b12c7fc4ae374a19cbfd637590926a40.png]: /images/20221022/e690482140b14cd5bcf65a2a8e4270f5.png
[d6282c4fa7c88b01d1f9b9c570097fff.png]: /images/20221022/dfc929dc13254a669fa6814024ab4a69.png
[a670ec98d5c903b63d5bfe6a3457432b.png]: /images/20221022/9f10e58c3a1448cf8c2201cad5c8767d.png
[9272ea47ebde70acb17c8101070200e8.png]: /images/20221022/1ff9c7a7aea34c94bd3b466d7befbb98.png
[49d68c42f233b5495230012e31d05837.png]: /images/20221022/5654d8dbc2cf41cb9b502d522c277fd7.png
[1ccb6c01962d04712ec0347f36c4ae31.png]: /images/20221022/9030496131964ddfba1193dabcba2ec4.png