Idea插件—Yapi文档上传插件

一、痛点

1、你还在为手动编写yapi接口而烦恼吗？

2、手动编写yapi接口既浪费时间又容易出错。

二、推荐插件

1、插件名称

YapiUploadPlus，插件地址(YapiUploadPlus - IntelliJ IDEs Plugin | Marketplace)

2、推荐原因

在 IntelliJ IDEA 插件仓库中有许多 Yapi 插件可供选择，但通过我的使用体验，我发现 YapiUploadPlus 插件是最为方便和实用的。这主要有两个原因：

• 1）插件的参数配置简单且合理。使用 YapiUploadPlus 插件时，参数配置非常容易，让人感到舒适和方便。
• 2）该插件支持将单个 API 文档上传到 Yapi，并且还支持一次性上传一个 Controller 类文件中的所有 API 文档。这为我们的工作提供了极大的便利，特别是在大型项目中管理 API 文档时，效率得到了显著提高。

总的来说，YapiUploadPlus 插件不仅易于配置，而且功能丰富，能够满足我们日常工作的需求，因此我强烈推荐使用它。

3、使用环境

名称	参数
系统	win10系统
idea版本	IntelliJ IDEA 2024.1 (Ultimate Edition)
插件版本	YapiUploadPlus 1.0.2

4、插件配置

1）在idea中安装完YapiUploadPlus插件后，点击Settings找到插件配置位置

2）参数配置

插件参数	YApi服务
YApi地址	Yapi服务地址
项目ID	Yapi项目中   项目》设置》项目设置》 项目ID
项目token	Yapi项目中   项目》设置》token配置》工具标识
tag	接口标签tag，根据需要配置（必须配置，若为空，会导致上传的接口在Yapi中编辑时存在异常）
status	接口状态选择
请求类型	接口类型选择

5、插件使用

• 单个 API 上传：只需选中需要上传的 API 接口方法，点击“上传到 Yapi”即可将该接口上传到 Yapi 中。

• 批量 API 上传：在需要上传 API 文档的 Controller 中，右键点击“上传到 Yapi”，即可将该 Controller 中所有的 API 接口上传到 Yapi 中。