用ApiFox MCP一鍵生成接口文檔,做接口測試

日常開發過程中,尤其是針對長期維護的老舊項目,許多開發者都會遇到一系列相同的困擾:由于項目早期缺乏嚴格的開發規范和接口管理策略,導致接口文檔缺失,甚至連基本的接口說明都難以找到。此外,由于缺乏規范化的接口測試,項目維護人員不得不耗費大量時間理解代碼邏輯,進而手動驗證接口功能。這種狀態不僅降低了開發效率,還嚴重影響了項目交接的順利進行。

今天在cursor中通過ApiFox MCP工具,一鍵獲取接口信息,一鍵實現接口測試,從而大幅提高接口管理效率。

一、老舊接口面臨的典型問題

老舊接口在開發和維護中面臨以下突出問題:

  1. 文檔缺失或不全: 在項目早期,由于開發節奏快,缺乏嚴格的接口文檔規范,導致后期維護人員難以快速掌握接口功能與調用方式。

  2. 接口測試缺失: 老舊項目的接口通常沒有對應的自動化測試腳本,測試往往依靠手工操作,不僅效率低下,也容易遺漏細節問題。

  3. 維護難度高: 缺乏清晰的接口文檔和有效的測試手段,使得后續維護人員需要花費大量時間閱讀代碼和調試接口。

這些問題在長期維護項目中尤為明顯,使得開發維護成本持續攀升。

二、ApiFox MCP的核心能力

1. 讀取個人項目的OpenApi Spec文件內容

2.?讀取個人項目"的OpenAPISpec文件內$ref的文件內容,可以同時獲取多個文件內容
Parameters:
path:OpenAPISpec文件內$ref的值,可以同時獲取多個文件內容,如:["/paths/_get_pet.json"
"/paths/_get_order.json"]

3.?從服務器重新下載最新的"個人項目"的OpenAPISpec文件內容

有了上面的幾個核心能力,我們就可以:根據接口文檔生成或修改代碼、搜索接口文檔內容等等,至于通過這個接口文檔數據能讓 AI 干什么更多更強大的活,請發揮你和你的想象力。

三、ApiFox MCP詳細操作指南

這里我用到了一個idea集成的工具 叫 Cool Request, 為什么不用ApiFox自帶的ApiFox 插件,是因為Cool Request太好用了,雖然同樣擁有定位接口,直接加載項目中接口的能力,但是CoolRequest可以直接調正在運行中的spring中的方法,也就是說,任何的方法,只要你想調,隨時都能通過CoolRequest去調用,這個絕對是開發過程中調試bug的神器。

好了,不說太多了,有點兒跑題了,可能有人會有疑問,說ApiFox MCP怎么就扯到了Cool Request上了,那么這兩個有什么關系呢?

我通過Cool Request可以一鍵將Api接口導入到ApiFox中,具體操作如下:

如果第一次操作,會彈出需要配置ApiFox

可以參考官網

1. HTTP Authorization

用于獲取、添加用戶自定義目錄

該Token請在Web端登錄后,按下F12進入開發者模式,任意選擇一個請求,點擊詳情,在請求頭中復制Authorization值。

Alt text

2. openapi token

下載一個官方客戶端,或在官方登錄后,在賬號設置中,可以新建一個訪問令牌

設置好這兩項之后,就可以一鍵導入Cool Request的api接口到ApiFox中了。

接下來需要配置ApiFox MCP server。在Cursor中, 添加配置

"API 文檔": {"command": "cmd","args": ["/c","npx","-y","apifox-mcp-server@latest","--project=XXXXXX"],"env": {"APIFOX_ACCESS_TOKEN": "XXXXXX"}
}

替換project和APIFOX_ACCESS_TOKEN

project如下圖在項目設置中找到基本設置,項目id。token與上文中的token為同一令牌。

設置好之后,就可以問cursor了

我發現,我問的時候,調用MCP工具查到了好多個跟 “航線” 相關的接口,即使我把名稱原封不動的復制進來也是存在這樣的問題。如果碰到這種問題怎么解決呢?

直接復制ApiFox的接口id來讓MCP精確執行

我們可以看到他會先刷新接口信息,根據最新的接口獲取詳情,然后再去生成對應的接口文檔。

接下來,我讓他幫我生成接口自動化測試,他也能很好的寫出來。

四、ApiFox MCP實戰效果

通過ApiFox MCP工具,我們能夠:

  1. 效率顯著提高: 接口文檔和測試腳本自動生成,省去了大量手動撰寫文檔和人工測試的時間。

  2. 接口質量穩步提升: 自動化測試腳本有效減少了人工測試的遺漏,接口質量得到保障。

  3. 維護成本降低: 清晰易讀的自動生成文檔使得新成員快速上手,大幅降低了知識傳遞成本。

五、ApiFox MCP應用場景

ApiFox MCP尤其適用于以下場景:

  • 老舊項目的維護與升級。

  • 團隊人員頻繁更替,需要快速交接項目。

  • 快速迭代的敏捷項目,需迅速生成和驗證接口。

本文來自互聯網用戶投稿,該文觀點僅代表作者本人,不代表本站立場。本站僅提供信息存儲空間服務,不擁有所有權,不承擔相關法律責任。
如若轉載,請注明出處:http://www.pswp.cn/bicheng/83755.shtml
繁體地址,請注明出處:http://hk.pswp.cn/bicheng/83755.shtml
英文地址,請注明出處:http://en.pswp.cn/bicheng/83755.shtml

如若內容造成侵權/違法違規/事實不符,請聯系多彩編程網進行投訴反饋email:809451989@qq.com,一經查實,立即刪除!

相關文章

26考研 | 王道 | 計算機組成原理 | 三、存儲系統

26考研 | 王道 | 計算機組成原理 | 三、存儲系統 文章目錄 26考研 | 王道 | 計算機組成原理 | 三、存儲系統3.1 存儲系統基本概念3.2 主存儲器1. 主存儲器的基本組成2. SRAM與DRAM1.DRAM和SRAM對比2.DRAM的刷新3.DRAM的地址線復用技術 3. 只讀存儲器ROM4.雙端口RAM和多模塊存儲…

IDEA 開發PHP配置調試插件XDebug

1、安裝PHP環境 為了方便,使用的PhpStudy。 安裝路徑:D:\resources\phpstudy_pro\Extensions\php\php7.3.4nts 2、下載Xdebug Xdebug: Downloads 選擇對應的版本下載,本次使用的是7.3。 3、配置Xdebug 在php.ini中添加Xdebug配置。 D…

Go 語言的 GC 垃圾回收

序言 垃圾回收(Garbage Collection,簡稱 GC)機制 是一種自動內存管理技術,主要用于在程序運行時自動識別并釋放不再使用的內存空間,防止內存泄漏和不必要的資源浪費。這篇文章讓我們來看一下 Go 語言的垃圾回收機制是如…

60天python訓練計劃----day45

DAY 45 Tensorboard使用介紹 知識點回顧: tensorboard的發展歷史和原理tensorboard的常見操作tensorboard在cifar上的實戰:MLP和CNN模型 之前的內容中,我們在神經網絡訓練中,為了幫助自己理解,借用了很多的組件&#x…

RocketMQ基礎概念的理解

1、生產者 生產者和主題之間存在多對多關系。一個生產者可以向多個主題發送消息,一個主題可以接收來自多個生產者的消息。這種多對多關系有助于提高性能擴展和災難恢復能力。 2、消費者以及消費者組 一個隊列可以被多個消費者(其中這多個消費者必須分…

Flash燒錄速度和加載配置速度(純FPGA ZYNQ)

在工程綜合完成或者implement完成后,打開綜合設計或者實現設計。 toots--->Edit Device Properties--->打開比特流設置 將bitstream進行壓縮 上圖中,時鐘頻率選擇的檔位有限,最大為66MHZ io的bus width可以設置為x1,x2,x4 vivado在設計…

優化09-表連接

一、表連接介紹 表連接類型 表連接是關系型數據庫關鍵特性,在關系型數據庫中,表連接分為三類:循環嵌套連接(Nested Loops Join)、哈希連接(Hash Join)、合并排序連接(Merge Sort J…

Dify工作流實踐—根據word需求文檔編寫測試用例到Excel中

前言 這篇文章依賴到的操作可查閱我之前的文章: dify里的大模型是怎么添加進來的:在Windows本地部署Dify詳細操作 flask 框架app.route()函數的開發和調用:PythonWeb開發框架—Flask工程創建和app.route使用詳解 結構化提示詞的編寫&…

AWTK 嵌入式Linux平臺實現多點觸控縮放旋轉以及觸點丟點問題解決

前言 最近涉及海圖的功能交互,多點觸摸又開始找麻煩。 在PC/Web平臺awtk是通過底層的sdl2庫來實現多點觸摸,但是在嵌入式Linux平臺,可能是考慮到性能原因,awtk并沒有采用sdl庫來做事件處理,而是自己實現一個awtk-lin…

Diffusion Planner:擴散模型重塑自動駕駛路徑規劃(ICLR‘25)

1. 概述 2025年2月14日,清華大學AIR智能產業研究院聯合毫末智行、中科院自動化所和香港中文大學團隊,在ICLR 2025會議上發布了Diffusion Planner——一種創新性的基于Diffusion Transformer的自動駕駛規劃模型架構。該系統聯合建模周車運動預測與自車行…

ESP32對接巴法云實現配網

目錄 序言準備工作巴法云注冊與使用Arduino準備 開發開始配網 序言 本文部分內容摘抄原創作者巴法云-做優秀的物聯網平臺 代碼有部分修改并測試運行正常 巴法云支持免費用戶通過開發對接實現各智能音箱設備語音控制智能家居設備,并有自己的App進行配網和控制&…

深度學習習題3

1.訓練神經網絡過程中,損失函數在一些時期(Epoch)不再減小, 原因可能是: 1.學習率太低 2.正則參數太大 3.卡在了局部最小值 A1 and 2 B. 2 and 3 C. 1 and 3 D. 都是 2.對于分類任務,我們不是將神經網絡中的隨機權重…

【EasyExcel】導出時添加頁眉頁腳

一、需求 使用 EasyExcel 導出時添加頁眉頁腳 二、添加頁眉頁腳的方法 通過配置WriteSheet或WriteTable對象來添加頁眉和頁腳。以下是具體實現步驟: 1. 創建自定義頁眉頁腳實現類 public class CustomFooterHandler implements SheetWriteHandler {private final…

c++ 類型轉換函數

測試代碼&#xff1a; void testTypeTransfer() { // 測試類型轉換函數class Distance {private:int meters;public:// 類型轉換函數&#xff0c;int表示轉化為int類型operator int() {std::cout << "調用了類型轉換函數" << endl;return meters; }Dist…

Conda 基本使用命令大全

Conda 基本使用命令大全 Conda 是一個開源的包管理和環境管理系統&#xff0c;廣泛用于 Python 開發、數據科學和機器學習。以下是 最常用的 Conda 命令&#xff0c;涵蓋環境管理、包安裝、配置等核心操作。 1. 環境管理 創建環境 conda create --name myenv # 創…

基于SpringBoot和PostGIS的OSM時空路網數據入庫實踐

目錄 前言 一、空間表的設計 1、屬性信息 2、空間表結構設計 二、路網數據入庫 1、實體類設計 2、路網數據寫入 3、pgAdmin數據查詢 三、總結 前言 在當今數字化時代&#xff0c;隨著信息技術的飛速發展&#xff0c;地理空間數據的應用范圍越來越廣泛&#xff0c;尤其是…

代付入賬是什么意思?怎么操作?

代付入賬就是指商戶委托銀行通過企業銀行賬戶向指定持卡人賬戶劃付款項&#xff0c;款項劃入指定賬戶即為入賬。 具體操作流程如下&#xff1a; 1. 向第三方支付公司指定賬戶充值加款。 2. 通過操作后臺提交代付銀行卡信息。 3. 第三方支付公司受理業務申請。 4. 第三方審…

數學復習筆記 27

前言 太難受了。因為一些事情。和朋友傾訴了一下&#xff0c;也沒啥用&#xff0c;幾年之后不知道自己再想到的時候&#xff0c;會怎么考慮呢。另外&#xff0c;筆記還是有框架一點比較好&#xff0c;這樣比較有邏輯感受。不然太亂了。這篇筆記是關于線代第五章&#xff0c;特…

第四十五天打卡

知識點回顧&#xff1a; tensorboard的發展歷史和原理 tensorboard的常見操作 tensorboard在cifar上的實戰&#xff1a;MLP和CNN模型 效果展示如下&#xff0c;很適合拿去組會匯報撐頁數&#xff1a; 作業&#xff1a;對resnet18在cifar10上采用微調策略下&#xff0c;用tensor…

使用高斯樸素貝葉斯算法對鳶尾花數據集進行分類

高斯樸素貝葉斯算法通常用于特征變量是連續變量&#xff0c;符合高素分布的情況。 使用高斯樸素貝葉斯算法對鳶尾花數據集進行分類 """ 使用高斯貝葉斯堆鳶尾花進行分類 """ #導入需要的庫 from sklearn.datasets import load_iris from skle…