idea的插件—可快速生成yapi的接口文檔（代碼0入侵）

1. 功能

• 導出http到（@Controller注解類）
  • Yapi
  • Postman
  • markdown
• 導出RPC到
  • Yapi
  • markdown
• Call api調(diào)用API接口

注意點：

1. 注釋中可以使用@module標注模塊所屬的模塊。表示接口會發(fā)布到y(tǒng)api模塊下；
2. 只能是類維度進行api接口上傳，建議每個類（Controller）根據(jù)業(yè)務維度設計，不要混亂。

2. 常用使用

2.1 安裝

Preferences → Plugins → Marketplace → 搜索“EasyYapi” → 安裝該插件 → 重啟IDE

2.2 idea配置

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

image.png

2.2.1 postman請求

生成postman的token

1. postman的token,可以從Postman Integrations Dashboard獲得

image.png

2. 在 API 文件類中使用 快捷鍵 Ctrl+Enter 選擇 ExportPostman.(Mac使用control+Entry)

3. 生成的格式

image.png

2.2.2 Yapi請求

1. 獲取Yapi的Token信息

image.png

2. 需要聲明注釋

IDEA創(chuàng)建類模板和方法模板（超詳細）

Java注釋規(guī)范(配合EasyYapi使用)

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


}

3. 結果信息

conrrol+Entry導出Yapi配置

image.png

生成的結果.png

2.3 Call api調(diào)用

在 api/rpc 文件中 使用 快捷鍵 Ctrl+Enter 選擇 Call API , 發(fā)起對當前文件中的API的請求。

image.png

推薦閱讀

IDEA創(chuàng)建類模板和方法模板（超詳細）

Java注釋規(guī)范(配合EasyYapi使用)

IDEA 插件 EasyYapi（圖文使用版）

Yapi的官方文檔

Yapi的官方使用說明

yapi開放 api