Kết nối dự án Apidog với AI

Apidog MCP Server cho phép AI kết nối và sử dụng các đặc tả API trong dự án Apidog của bạn, giúp trợ lý AI tạo mã, tìm kiếm đặc tả và tăng tốc quy trình phát triển.

Điều kiện tiên quyết

Trước khi cấu hình MCP client, hãy đảm bảo bạn có:

Node.js (phiên bản 18 trở lên, tốt nhất là phiên bản LTS mới nhất)

Một IDE tương thích với MCP:

Cursor

VS Code + plugin Cline

Các trình biên tập khác hỗ trợ MCP

Lấy thông tin xác thực cần thiết

Tạo API Access Token

Mở Apidog và di chuột qua ảnh hồ sơ của bạn (góc trên bên phải)

Chọn Account Settings → API Access Token

Tạo API access token mới

Sao chép token để thay thế <access-token> trong cấu hình

Lấy Apidog Project ID (Tùy chọn)

Mở dự án mục tiêu của bạn trong Apidog

Nhấp vào Project Settings trong thanh bên trái

Điều hướng đến Basic Settings

Sao chép Project ID để thay thế <project-id> trong cấu hình

Sao chép cấu hình MCP trong dự án

Bạn có thể mở bất kỳ API nào và sử dụng mục AI Coding để sao chép trực tiếp cấu hình MCP của API đó.

Cấu hình MCP trong Cursor

Mở cài đặt MCP

Mở trình biên tập Cursor

Nhấp vào biểu tượng cài đặt (góc trên bên phải)

Chọn MCP từ menu bên trái

Nhấp vào + Add new global MCP server

Thêm cấu hình

Dán cấu hình sau vào tệp mcp.json đã mở. Thay thế <access-token> và <project-id> bằng các giá trị thực tế của bạn:

macOS / Linux

Windows

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--project-id=<project-id>"
      ],
      "env": {
        "APIDOG_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

Xác minh cấu hình

Kiểm thử kết nối bằng cách hỏi AI (ở chế độ Agent):

Please fetch API specification via MCP and tell me how many endpoints exist in the project

Nếu AI trả về thông tin API của dự án Apidog của bạn, kết nối đã thành công.

Lưu ý quan trọng

Thay thế <access-token> và <project-id> bằng API access token Apidog cá nhân và project ID của bạn.

Làm việc với nhiều dự án

Để làm việc với đặc tả API từ nhiều dự án, hãy thêm nhiều cấu hình MCP Server vào tệp cấu hình. Mỗi dự án nên có <project-id> riêng biệt và duy nhất.

Để rõ ràng, hãy đặt tên cho từng MCP Server theo định dạng "[Tên dự án] API Specification".

Thực hành bảo mật tốt nhất

Nếu nhóm của bạn đồng bộ tệp cấu hình MCP vào kho lưu trữ mã:

Xóa dòng "APIDOG_ACCESS_TOKEN": "<access-token>" khỏi cấu hình

Cấu hình APIDOG_ACCESS_TOKEN làm biến môi trường trên máy của từng thành viên trong nhóm

Điều này ngăn chặn rò rỉ token trong hệ thống kiểm soát phiên bản.

Triển khai tại chỗ

Đối với các triển khai tại chỗ, hãy bao gồm địa chỉ API của máy chủ của bạn trong cấu hình MCP của IDE:

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--project-id=<project-id>",
        "--apidog-api-base-url=<your-server-url>"
      ],
      "env": {
        "APIDOG_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

Thay thế <your-server-url> bằng địa chỉ API của máy chủ tại chỗ của bạn (bắt đầu bằng http:// hoặc https://). Đảm bảo có quyền truy cập mạng đến www.npmjs.com.

Nguồn dữ liệu khác

Kết nối tài liệu API trực tuyến được xuất bản bởi Apidog với AI

Kết nối tệp OpenAPI với AI

Câu hỏi thường gặp

Tôi đang sử dụng Apidog Europe. Tôi có cần cấu hình đặc biệt nào khi khởi động MCP server không?

Có. Nếu bạn đang sử dụng Apidog Europe, bạn cần thêm tham số --apidog-api-base-url và đặt tham số đó thành endpoint API EU.

Dưới đây là một ví dụ cấu hình:

"Pet Store- Apidog": {
  "command": "npx",
  "args": [
    "-y",
    "apidog-mcp-server@latest",
    "--project-id=xxx",
    "--apidog-api-base-url=https://api.eu.apidog.com"
  ],
  "env": {
    "APIDOG_ACCESS_TOKEN": "xxx"
  }
}

Sự cố cấu hình trên Windows

Vấn đề về phiên bản Node.js

Làm thế nào để AI đọc dữ liệu mới nhất từ các đặc tả API đã cập nhật?

Kết nối dự án Apidog với AI

Điều kiện tiên quyết#

Lấy thông tin xác thực cần thiết#

Cấu hình MCP trong Cursor#

Lưu ý quan trọng#

Làm việc với nhiều dự án#

Thực hành bảo mật tốt nhất#

Triển khai tại chỗ#

Nguồn dữ liệu khác#

Câu hỏi thường gặp#

Điều kiện tiên quyết

Lấy thông tin xác thực cần thiết

Cấu hình MCP trong Cursor

Lưu ý quan trọng

Làm việc với nhiều dự án

Thực hành bảo mật tốt nhất

Triển khai tại chỗ

Nguồn dữ liệu khác

Câu hỏi thường gặp