推薦一款IDEA插件,堪稱后端接口自動生成神器!
VSole2023-01-10 10:23:20
一、先看效果
1、生成yapi文檔的效果

2、生成postman格式數據并導入接口測試類后的效果(如postman、apifox等工具)

3、生成markdown格式文檔的效果

二、安裝
1、安裝EasyYapi插件
idea的頂部菜單欄選擇 文件 -> 設置 -> 插件,然后再marketplace里搜索easyYapi安裝即可

安裝完成后設置底部回出現EasyApi的欄目,選中進行配置修改(我主要是改了下圖紅框的位置,不修改使用默認配置也可以,自己可以試試使用json5和不適用json5的區別,我更喜歡看json5格式的文檔【也是最近才發現有這個格式的】)

2、安裝yapi接口文檔管理系統
如果只需要在postman等接口工具中使用,可以跳過此步驟
官方部署文檔:
- https://hellosean1025.github.io/yapi/devops/index.html
注意 :node.js不要安裝最高版本(我安裝最高版本時安裝yapi失敗,node.js重新安裝12.x版本后成功)
三、接口編寫

接口上的注釋自動會生成接口名稱和接口的描述信息,實體類里的注釋也會自動生成文檔里的字段說明
四、生成文檔
快捷鍵:Shift + Alt + E
更多使用教程見官網文檔:
- https://easyyapi.com/index.html

如果選擇yapi,首次需要填寫一個yapi服務的地址,如:127.0.0.1:3000
然后需要填寫項目的token,這個token是yapi服務器新建項目后生成的token

VSole
網絡安全專家