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

盗名仕

已于 2023-05-16 20:19:44 修改

阅读量2.2k

点赞数 2

CC 4.0 BY-SA版权

分类专栏： IDE 文章标签： java 开发语言

于 2023-05-16 20:00:27 首次发布

本文链接：https://blog.csdn.net/kanhcj86/article/details/130712939

IDE 专栏收录该内容

25 篇文章

订阅专栏

EasyYapi是一款用于快速生成API接口文档的插件，支持从HTTP和RPC导出到Yapi或Postman。用户需在IDE中安装插件，配置token信息，通过注解如@module指定模块归属。在类（@Controller）中使用Ctrl+Enter导出Postman格式，@ignore可忽略接口生成文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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

1. 功能

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

注意点：

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

2. 常用使用

2.1 安装

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

2.2 idea配置

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

2.2.1 postman请求

生成postman的token

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

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

2.2.2 Yapi请求

获取Yapi的Token信息

需要声明注释

/**
 * @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;
    }


}