EasyYapi插件—快速生成API接口文档

1. 功能

• 导出http到（@Controller注解类）
  • Yapi
  • Postman
  • markdown
• 导出RPC到
  • Yapi
  • markdown
• Call api调用API接口

注意点：

1. 注释中可以使用@module标注模块所属的模块。表示接口会发布到yapi模块下；
2. 只能是类维度进行api接口上传，建议每个类（Controller）根据业务维度设计，不要混乱。

2. 常用使用

2.1 安装

Preferences → Plugins → Marketplace → 搜索“EasyYapi” → 安装该插件 → 重启IDE

2.2 idea配置

使用下面的方式获取token信息，并配置在idea中。

2.2.1 postman请求

生成postman的token

1. postman的token,可以从Postman Integrations Dashboard获得

1. 在 API 文件类中使用 快捷键 Ctrl+Enter 选择 ExportPostman.(Mac使用control+Entry)
2. 生成的格式

2.2.2 Yapi请求

1. 获取Yapi的Token信息

1. 需要声明注释

/**
 * @module Yapi的模块名称
 */
@RestController
@RequestMapping("/asa")
public class Aa {

    @RequestMapping("/api")
    public Order r(@RequestBody Order order) {
        return order;
    }

    /**
     * @ignore 该接口不生成Yapi文档
     */
    @RequestMapping("/api")
    public TestTable1 r1(@RequestBody TestTable1 testTable1) {
        return testTable1;
    }


}