RunApi使用详解

前言

不管是前端还是后端，在开发中都需要一个调试接口的工具，比如：Swagger，再比如PostMan，目前市面上有很多这种接口调试工具，而这篇博客介绍的是RunApi，不仅可以轻松、简洁的实现接口调试，还可以自动生成在线的接口文档，是非常非常方便的。

---

1、RunApi是什么？

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

它和showdoc( https://www.showdoc.com.cn/help )相辅相成：showdoc以文档为核心，侧重文档编写和知识资料沉淀。而runapi则以接口为核心，包含接口测试、管理等一系列功能。同时它将自动生成文档到showdoc，以及共用showdoc的团队管理机制，很好地实现接口的自动化和多人协作。相信使用 showdoc + runapi 这两个工具组合，能够极大地提高IT团队的效率。

2、下载RunApi客户端

https://www.showdoc.com.cn/runapi/30291
官网推荐直接使用客户端，确实也比较好用

3、使用RunApi

1、先创建一个项目

2、点击APIS,再点击下拉框选择刚刚创建的项目
3、新建目录

4、可以选择添加子目录，也可以直接添加子页面，也就是接口

5、选择带调试功能的API接口，点击确定

6、填写接口信息即可

返回成功

7、关键来了，如果是PostMan到这里是不是代表接口调试成功了，但对于RunApi，此时我们可以点击一个保存，
8、再点击文档链接，就可以看到刚刚我们的接口信息，RunApi自动帮我们生成一个看起来很清爽的接口文档了。

我们复制链接，使用浏览器打开

怎么样，是不是看起来特别清爽，并且只需要我们在写参数的时候写好备注，那么这些备注信息自动会生成的，十分的方便，可以有效减少和前端的沟通。（毕竟有的时候沟通成本也是比较大的）

---

总结

RunApi可以看作是PostMan的精简版，但又有根据接口信息自动生成接口文档的功能。

补充：RunApi进行接口调试添加Token可以查看这篇博客：https://blog.youkuaiyun.com/weixin_47316183/article/details/126804925