API测试服务器

使用MCP服务器进行API测试（最终用户指南）

一个用于HTTP API测试的即用型模型上下文协议（MCP）服务器，由Playwright驱动。本指南帮助您将MCP服务器作为npm包在本地安装、配置和运行。

📋 目录

• 概述
• 先决条件
• 设置
• 配置
• 使用方法
• MCP服务器使用示例场景和提示
• 即将推出的改进
• 故障排除
• 支持
  
  

🌟 概述

Playwright API MCP服务器通过模型上下文协议支持API测试。它支持GET、POST、PUT和DELETE请求。

📋 前提条件

• Node.js版本18.0.0或更高版本。
• **npm（Node Package Manager，Node包管理器）**随Node.js一起提供。
• VS Code兼容MCP的客户端。
• GitHub Copilot确保在 VS Code 中已安装并启用了 GitHub Copilot 扩展。
  观看视频以了解如何启用 Github Copilot：https://www.youtube.com/watch?v=etP5wq4Zl20
• 如何免费使用Github Copilot 观看视频：https://www.youtube.com/watch?v=X_Aet9ndh_Y
  
  

🚀 设置

1. 在VS Code中创建一个Node.js项目:

   • 创建一个具有有意义名称的新文件夹（例如。 my-project）。
   • 在 Visual Studio Code 中打开该文件夹。
   • 启动集成终端（通过 View > Terminal）。
   • 选择您喜欢的外壳（例如。 Git Bash, Command Prompt, or PowerShell）。
   • 运行以下命令来初始化项目：
     复制

     npm init -y
     

   • 这将生成一个带有默认设置的 package.json 文件
     

2. 安装MCP服务器包

   • 现在，请运行以下命令来安装mcp服务器包。
     复制

     npm i @automate-io/api-testing-mcp@latest
     

⚙️ 配置

1. 在VS Code中打开你的项目文件夹

2. 如果 mcp.json 文件不存在，请在其中创建它 root/.vscode/ 目录。 如果文件已经存在，您可以跳过此步骤

3. 加上 api-testing-mcp 以下的配置 servers 输入……的密钥 mcp.json 文件，如下所示

   复制

   {
     "servers": {
       "api-testing-mcp": {
         "type": "stdio",
         "command": "node",
         "args": ["node_modules/@automate-io/api-testing-mcp/dist/server.js"],
         "cwd": "${workspaceFolder}"
       }
     },
     "inputs": []
   }
   

• ❗重要提示如果你正在从事一项 monorepo，确保 args 你领域的（或：在你所在领域） mcp.json 文件已正确配置。请参阅 单仓库MCP配置 详细说明指南。
  如果你的测试代码位于一个 standalone 仓库中无需进行任何更改，您可以继续进行。
  
  

📖 开始进行MCP测试

1. 启动MCP服务器

• 点击如下图所示的mcp.json文件中高亮显示的启动按钮以启动MCP服务器。

  
  

2. 输入提示

• 在 VS Code 中打开 GitHub Copilot 聊天窗口，并选择代理模式。
• 输入一个概述您希望测试的API的提示。
  
  

✅ MCP服务器使用示例场景和提示

• 场景1 一次性测试所有终端点。
  
• 情景2 测试单个端点。
  
  

⏭️ 即将推出的增强功能

• 为响应数据实施模式验证
• 添加可重用资源以支持API测试工作流
• 引入预定义提示以简化常见场景
• 提供一个示例HTML测试报告模板，以指导LLM了解布局和格式设置
• 重构现有逻辑并实现健壮的错误处理机制，以提高可靠性和可维护性
  
  

🔧 故障排除

• 服务器没有运行？
  仔细检查您的MCP客户端配置。
  

• 模块未找到？
  重新安装该软件包：
  

  复制

  npm i @automate-io/api-testing-mcp@latest
  

🆘 支持

• 请查阅本指南及您的MCP客户端文档。
• 对于问题，请打开 GitHub Issues（GitHub问题） 在这里。
• 咨询 模型上下文协议文档。

---

👍 享受探索和验证您的API的过程吧！