IDEA 插件 EasyYapi

通過 YAPI 的 開放 API , 首先我們會產生一個想法, 開發一個 IDEA 的插件, 產生這個想法以后, 就去先去插件市場里搜尋, 果然已經有很多大佬先一步開發好了. 這里先一步幫大家也篩選了一下, 選擇了對代碼 0 入侵的 EasyYapi

功能

1. 導出http到
   • Yapi
   • Postman
   • markdown
2. 導出rpc到
   • Yapi
   • markdown
3. Call api 調用 API

安裝

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

配置

進入 Preferences(Settings) > Other Settings > EasyApi > Support, 主有三項:

• Postman token 配置
• Yapi 配置 , 第一次導出的時候會引導配置, 這里不用手動配置
• RPC : Support >[ √ ] methodDoc

YAPI token 獲取

Postman token 獲取

Postman token 獲取頁面

使用

1. 導出

   選中 一個或多個 API 文件(Controller 或是 RPC Interface), 使用快捷鍵alt shift E(windows)/ctrl E(mac)

   選導出類型以及導出的接口, 確定后回車

   導出到 YAPI 服務

   

   導出到 PostMan

   PostMan 是給功能強大的 工具, 應該有很多人跟我一樣接口測試會習慣性依賴 PostMan

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

   2. 可以在Preferences(Settings) > Other Settings > EasyApi 中手動配置

   3. 在 API 文件類中使用 快捷鍵 Ctrl+Enter 選擇 ExportPostman.

   4. 反應會慢一點. 之后就會在你的PostMan 中出現

   

導出到Markdown

2. Call API

在 api/rpc 文件中 使用 快捷鍵 Ctrl+Enter 選擇 Call API , 發起對當前文件中的API的請求(有點雞肋的功能, 不過在沒有 yapi 和 postMan 的情況下可以使用)

總結

可以看到 EasyYapi 提供了 豐富的 API 導出功能, 即使不依賴 YAPI , PostMan 也可以滿足基本需求.

另外EasyYapi 對注釋規范要求很高. 不過這另一方面也提高了對編碼的注釋規范, 有利有弊.

按照YAPI + EasyYapi 的方式書寫 API . 我們一個字段的注釋.在先編寫代碼再導出到 YAPI 的方式 , 我們只需要寫一遍注釋即可 .

先寫完接口即可 , 后續邏輯導出后再補充也不遲 .

寫在最后

還是老三樣. 歡迎 點贊, 轉發, 評論 ~