ApiPost插件在idea中的使用

最新推荐文章于 2024-09-21 21:59:24 发布

疯子-可疯

最新推荐文章于 2024-09-21 21:59:24 发布

阅读量3.5k

点赞数 10

分类专栏： # idea 文章标签： intellij-idea java ide

本文链接：https://blog.csdn.net/sw150811426/article/details/135692744

版权

idea 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

最近公司项目规范化，想要生成接口文档，所以使用了apipost软件，但是接口参数一个一个写太麻烦了，所以研究了一下apipost这个插件的使用。

我使用的idea版本为IntelliJ IDEA 2021.3

了解一下apipost

官方网址：https://www.apipost.cn/

Apipost是一款API协同研发工具，隶属于北京北极狐信息科技有限公司，主要服务有API 设计、API 调试、API 文档、API 自动化测试。

下载apipost插件

“文件”–》“设置”–》“插件”【快捷键ctrl+alt+s】，打开插件页面
在这里插入图片描述
点击“Marketplace”，输入“Apipost”，选择“Apipost-Helper-2.0”，点击安装，应用。可能会提示重启idea，重启即可。

配置Apipost

打开Apipost软件，找到“项目设置”，单击“open API”，看看有没有API_token,若没有，点击“创建”，新建一个token，名字随便填，然后点击生成API_token
在这里插入图片描述

然后就会生成一个token，复制该token
![](https://img-blog.csdnimg.cn/direct/d2324a8581cf4235bffdc81aafc1af51.png
回到idea，idea重启后，再次打开设置页【快捷键ctrl+alt+s】，点击“其他设置”，点击Apipost V2 Config，和APIPOST进行关联，把复制的token放到请求token中，点击“应用”，“确认”，设置完成。
在这里插入图片描述

调试

在调试的方法前，会有调试标识，和FastRequest插件的用法大差不离，点击按钮，会在右侧出现Apipost窗口，生成相应的请求参数和路径
在这里插入图片描述
点击“Send”即可进行接口调试。
若是微服务项目，url前缀不同，也可单独设置，选中服务，鼠标右键，点击“前置URL设置”，设置好，点击“保存”即可。

上传接口

测试好了，要把接口上传到远程，特定接口，直接点击“Send”按钮旁的“Upload”，按钮即可。上传成功后，会有成功提示。
在这里插入图片描述
若要一整个controller上传，则选择文件，右键选择“Upload To ApiPost V2”，进行上传。

若一个模块的文档上传，同上。
上传完，即可到Apipost上看更新的文件了，别忘了刷新。