一、IDEA裝入Apifox
1.安裝Apifox Helper
說明:在 IntelliJ IDEA 中安裝 ApiFox Helper 插件。
2.打開Apifox
說明:點擊 設置,在菜單中選擇 API訪問令牌。在彈出的窗口中輸入任意名稱,并選擇令牌的有效期(為了方便,我這里選擇了 無期限)。生成令牌后,由于 令牌只能復制一次,請務必妥善保存。
3.測試令牌
說明:點擊 ApiFox Helper,選擇 上傳到 ApiFox,將剛才復制的 API 訪問令牌粘貼進去,然后點擊 測試令牌。如果測試成功,右側會顯示成功提示消息。
4.配置Apifox相關配置
說明:點擊 加號圖標,選擇對應的 ApiFox 項目,在右側框中選擇相應的模塊和分支,然后點擊 確定 即可完成配置。
二、Apifox常用注解
說明:ApiFox 兼容 Spring Boot 注解生成接口文檔。對 OpenAPI 3 / springdoc 注解