IDEA插件系列-EasyYapi

插件介绍

• 使用手册
• 源码地址

使用方式

安装

安装方式

请使用这个版本 ~~easy-yapi.2.1.3.183.0.jar~~ ：https://github.com/tangcent/easy-yapi/releases/download/v2.1.3/easy-yapi.2.1.3.183.0.jar

rpc接口导入支持以下使用方法

1. 打开项目中的包含rpc的文件或者在IDEA的左边项目文件区域选择文件或者文件夹 使用快捷键alt shift E(windows)/ctrl E(mac) 然后选择要导出的API,选择导出渠道Yapi/Markdown 点击[✔]按钮或者按回车键完成导出
2. 打开项目中的包含rpc的文件 右键文件内容选择Generate...或者用[Alt + Insert]/[Ctrl+Enter](快捷键可能不一样)" 然后选择ExportYapi/ExportMarkdown
3. 在IDEA的左边项目文件区域选择文件或者文件夹 鼠标点击最上方Code > ExportYapi/ExportMarkdown

---

rpc相关规则

规则的key	规则目标(上下文)	版本	规则描述
☆mdoc.class.filter	class	v0.9.5+	选择哪些类可以导出方法文档(rpc)
mdoc.method.filter	method	v0.9.5+	选择哪些方法可以导出方法文档(rpc)
☆mdoc.method.path	method	v0.9.5+	设置方法文档(rpc)的路径
mdoc.method.http.method	method	v0.9.5+	设置方法文档(rpc)HTTP请求方式

点击规则配置查看更多.

---

• **导出rpc方法的功能默认是关闭的 , 开启需要勾选:Preferences(Settings) > Other Settings > EasyApi > Support > methodDoc** , 参见:IDEA配置
• rpc文档支持导出到yapi/markdown

rest接口导入

支持以下使用方法

1. 打开项目中的包含api/rpc的文件或者在IDEA的左边项目文件区域选择文件或者文件夹 使用快捷键alt shift E(windows)/ctrl E(mac) 然后选择要导出的API,选择导出渠道Yapi 点击[✔]按钮或者按回车键完成导出
2. 打开项目中的包含api/rpc的文件 右键文件内容选择Generate...或者用[Alt + Insert]/[Ctrl+Enter](快捷键可能不一样)" 然后选择ExportYapi
3. 在IDEA的左边项目文件区域选择文件或者文件夹 鼠标点击最上方Code > ExportYapi
4. 鼠标点击最上方Code > YapiDashBoard 然后就可以用鼠标将左边的API拖动到右边yapi目录中，完成API导出到Yapi

---

• 初次使用可能会以弹窗的方式要求输入必要的信息,参见:yapi配置
• 熟悉后可以尝试:yapi mock

项目中使用

在项目根路径加入 .easy.api.config 文件

代码注释配置

类注释

/**
 * 前置网关配置中心方案设计
 *
 * @author Khalid
 * @version V1.0
 * @since 2021-03-02 09:13
 */
@RestController
public class GatewayConfigCenterController {
   
}

方法注释

/**
 * 获取业务通用配置
 *
 * @param interchangeableConfigQueryParam
 * @return
 * @folder 自助终端配置中心方案设计
 */
@PostMapping("/gateway/configcenter/getInterchangeableConfig")
@ResponseBody
public Result<List<InterchangeableConfigVO>> getInterchangeableConfig(
    @RequestBody InterchangeableConfigQueryParam interchangeableConfigQueryParam) {
   
    return Results.success(new ArrayList<>());
}

字段注释

package com.khalidlife.demo.schemedesign.controller.param;

import java.util