Gần đây, ngay cả một lập trình viên mới như tôi cũng có thể viết mã cấp chuyên nghiệp nhờ sức mạnh của AI. Tuy nhiên, khi nói đến phát triển API, việc phải đối chiếu với tài liệu đặc tả và viết mã một cách tỉ mỉ thực sự... nói thẳng ra là khá phiền phức (cười).
Gần đây tôi đã phát hiện ra sự kết hợp giữa Cursor và Apidog MCP Server. Thật sự quá tuyệt vời! Bạn có thể cho phép AI đọc trực tiếp tài liệu đặc tả API và tự động tạo mã. Nghe có vẻ như "Ồ, điều đó có thể làm được sao?". Hôm nay tôi sẽ chia sẻ với các bạn trải nghiệm gây sốc này!
Apidog MCP Server là gì?
MCP (Model Context Protocol) là một giao thức kết nối AI với các nguồn dữ liệu bên ngoài. Nói đơn giản, nó thiết lập một giao diện tiêu chuẩn cho ứng dụng AI, cho phép kết nối dễ dàng với nhiều nguồn dữ liệu và công cụ khác nhau.
Sử dụng Apidog MCP Server, bạn có thể cung cấp tài liệu API trong dự án Apidog làm nguồn dữ liệu cho các IDE hỗ trợ AI như Cursor. Điều này cho phép AI truy cập trực tiếp vào dữ liệu tài liệu API của dự án.
Nhà phát triển có thể thông qua trợ lý AI để tạo hoặc sửa đổi mã dựa trên tài liệu API, tìm kiếm nội dung tài liệu API, v.v. Thành thật mà nói, những điều tuyệt vời mà AI có thể làm với cơ chế này chỉ giới hạn bởi trí tưởng tượng của bạn!
Cách thiết lập trong Cursor (cực kỳ đơn giản!)
1. Những thứ cần chuẩn bị
- Môi trường Node.js (phiên bản 18 trở lên, khuyến nghị sử dụng phiên bản LTS mới nhất)
- Phiên bản mới nhất của Cursor
- Dự án Apidog có thể truy cập
Apidog MCP Server có 3 cách sử dụng:
-
Khi sử dụng tài liệu API trong dự án Apidog
- Lý tưởng khi bạn muốn AI đọc tài liệu API của team mình
- Yêu cầu token truy cập cá nhân Apidog
-
Khi sử dụng tài liệu API được công khai
- Thuận tiện khi bạn muốn AI đọc tài liệu API được công khai bởi người khác
- Không yêu cầu token truy cập cá nhân Apidog (chỉ hỗ trợ tài liệu công khai không có mật khẩu hoặc hạn chế)
-
Khi sử dụng tài liệu OpenAPI/Swagger
- Khi bạn muốn AI đọc file Swagger/OpenAPI cục bộ hoặc trực tuyến
- Không yêu cầu dự án Apidog hoặc token truy cập
2. Lấy thông tin xác thực cần thiết
- Lấy Apidog Access Token
- Mở ứng dụng Apidog
- Di chuột qua biểu tượng ở góc trên bên phải, nhấp vào "Cài đặt tài khoản → Token truy cập API"
- Tạo token truy cập API mới và lưu lại
- Lấy ID dự án Apidog
- Mở dự án Apidog bạn muốn kết nối
- Nhấp vào "Cài đặt dự án" ở thanh bên trái
- Sao chép ID dự án từ trang "Cài đặt cơ bản"
3. Cài đặt MCP trong Cursor
Bạn có thể cấu hình bằng cài đặt toàn cục (khuyến nghị) hoặc cài đặt dự án.
Đối với cài đặt toàn cục:
-
Mở Cursor, nhấp vào biểu tượng "Cài đặt" ở góc trên bên phải, chọn tùy chọn "MCP" ở bên trái, sau đó nhấp vào nút "+ Add new global MCP server".
-
Thêm cấu hình sau vào file
mcp.json
đã mở (thay thế<access-token>
và<project-id>
bằng giá trị của bạn):
{ "mcpServers": { "API specification": { "command": "npx", "args": [ "-y", "apidog-mcp-server@latest", "--project-id=<project-id>" ], "env": { "APIDOG_ACCESS_TOKEN": "<access-token>" } } }
}
Nếu bạn đang sử dụng Windows, bạn có thể cần cấu hình này:
{ "mcpServers": { "API specification": { "command": "cmd", "args": [ "/c", "npx", "-y", "apidog-mcp-server@latest", "--project-id=<project-id>" ], "env": { "APIDOG_ACCESS_TOKEN": "<access-token>" } } }
}
Đối với cài đặt dự án:
- Tạo thư mục
.cursor
trong thư mục gốc của dự án - Tạo file
mcp.json
trong thư mục đó - Sử dụng cấu hình giống như trên
4. Xác nhận kết nối
Sau khi hoàn tất cài đặt, bạn có thể hỏi AI để xác nhận kết nối hoạt động bình thường (chế độ Agent):
Vui lòng lấy tài liệu API thông qua MCP và cho tôi biết có bao nhiêu API trong dự án
Nếu AI trả về thông tin API từ dự án Apidog của bạn, kết nối đã thành công!
Ví dụ thực tế: Phát triển siêu hiệu quả với AI×API!
Ví dụ 1: Tạo mã mô hình siêu nhanh
Giả sử bạn đang phát triển một trang thương mại điện tử và tài liệu API đã định nghĩa các giao diện và cấu trúc dữ liệu liên quan đến sản phẩm.
Các bước:
-
Mở Cursor và tạo dự án mới
-
Yêu cầu AI như sau:
Vui lòng lấy tài liệu API thông qua MCP và tạo định nghĩa giao diện TypeScript đầy đủ cùng lớp dịch vụ cho API liên quan đến sản phẩm
AI sẽ:
- Đọc tài liệu API thông qua MCP
- Phân tích giao diện và cấu trúc dữ liệu liên quan đến sản phẩm
- Tạo mã giao diện TypeScript và lớp dịch vụ phù hợp với đặc tả API
Ví dụ 2: Đồng bộ cập nhật tài liệu API và mã
Khi tài liệu API được cập nhật, mã cũng cần được cập nhật đồng bộ.
Các bước:
-
Cập nhật API sản phẩm trong Apidog, thêm trường mới
discountPrice
-
Yêu cầu AI cập nhật mã:
Tài liệu API đã được cập nhật. Vui lòng làm mới bộ nhớ cache MCP và cập nhật giao diện Product, thêm trường mới từ tài liệu API
AI sẽ:
- Làm mới bộ nhớ cache MCP để lấy tài liệu API mới nhất
- Xác định trường mới
discountPrice
- Cập nhật mã giao diện Product
Ví dụ:
export interface Product { id: string; name: string; description: string; price: number; discountPrice?: number; // trường mới category: string; imageUrls: string[]; inStock: boolean; createdAt: string; updatedAt: string;
}
Ví dụ 3: Tự động tạo hoạt động CRUD đầy đủ
Đối với nhà phát triển back-end, bạn có thể tự động tạo mã Controller, Service và Repository từ tài liệu API.
Các bước: Chỉ cần yêu cầu AI như sau:
Dựa trên tài liệu API, vui lòng tạo mã Spring Boot MVC đầy đủ cho module quản lý người dùng, bao gồm Controller, Service và Repository
AI sẽ tạo cấu trúc mã Spring Boot đầy đủ phù hợp với đặc tả API của bạn. Thật tiện lợi phải không!
Ví dụ 4: Tìm kiếm và hỏi đáp về tài liệu API
Bạn có thể sử dụng AI để tìm kiếm và hiểu tài liệu API phức tạp.
Ví dụ:
Trong tài liệu API, hãy tìm tất cả các giao diện liên quan đến thanh toán và giải thích mối quan hệ và quy trình sử dụng của chúng
AI sẽ:
- Tìm kiếm các giao diện liên quan đến thanh toán từ tài liệu API thông qua MCP
- Phân tích mối quan hệ giữa các giao diện này
- Giải thích quy trình thanh toán một cách dễ hiểu
Ví dụ 5: Tự động tạo mã kiểm thử
Các bước: Yêu cầu AI tạo mã kiểm thử:
Dựa trên tài liệu API trong MCP, vui lòng tạo mã kiểm thử đơn vị và tích hợp đầy đủ cho giao diện tạo sản phẩm bằng framework Jest
AI sẽ tạo mã kiểm thử phù hợp với đặc tả API của bạn, bao gồm cả trường hợp bình thường và các điều kiện biên khác nhau. Điều này giải quyết vấn đề phiền phức khi viết kiểm thử!
Kỹ thuật nâng cao và thực hành tốt nhất
1. Quản lý nhiều dự án API
Nếu bạn muốn sử dụng tài liệu API từ nhiều dự án Apidog trong cùng một môi trường phát triển, bạn có thể thêm nhiều dịch vụ vào cấu hình MCP:
{ "mcpServers": { "Đặc tả API Marketplace": { "command": "npx", "args": [ "-y", "apidog-mcp-server@latest", "--project=<project-id>" ], "env": { "APIDOG_ACCESS_TOKEN": "<access-token>" } }, "Đặc tả API CRM": { "command": "npx", "args": [ "-y", "apidog-mcp-server@latest", "--project=<project-id>" ], "env": { "APIDOG_ACCESS_TOKEN": "<access-token>" } } }
}
Khi hỏi AI, chỉ định rõ tài liệu API nào bạn muốn sử dụng:
Vui lòng sử dụng đặc tả API Marketplace để tạo mã cho module quản lý đơn hàng
2. Thực hành bảo mật tốt nhất
Để tránh chia sẻ Access Token khi làm việc nhóm:
-
Xóa phần
"APIDOG_ACCESS_TOKEN": "<access-token>"
khỏi file cấu hình -
Thiết lập biến môi trường
APIDOG_ACCESS_TOKEN
trên hệ thống của mỗi nhà phát triển
3. Kỹ thuật prompt để nâng cao chất lượng phản hồi AI
- Chỉ định rõ phần tài liệu cần thiết: ví dụ "Vui lòng kiểm tra tài liệu API của module người dùng"
- Chỉ định phong cách và quy ước mã: ví dụ "Tạo mã theo quy tắc đặt tên TypeScript của team chúng tôi"
- Yêu cầu thêm chú thích: ví dụ "Khi tạo mã, vui lòng thêm chú thích JSDoc chi tiết cho mỗi phương thức"
- Yêu cầu từng bước: đối với tác vụ phức tạp, trước tiên yêu cầu AI liệt kê kế hoạch, sau đó thực hiện từng bước một
Kết luận: Tương lai phát triển thay đổi với sự kết hợp AI×API!
Kết hợp Apidog MCP Server với Cursor mang lại trải nghiệm phát triển API tuyệt vời chưa từng có. Bằng cách cho phép AI truy cập trực tiếp vào tài liệu API, bạn có thể:
- Giảm đáng kể thời gian chuyển đổi từ đặc tả API sang triển khai mã
- Giảm khả năng xảy ra lỗi do con người
- Đẩy nhanh quá trình lặp lại và cập nhật
- Nâng cao chất lượng và tính nhất quán của mã
Thành thật mà nói, thời gian tôi đã dành hàng giờ để đối chiếu với tài liệu API giờ đây được rút ngắn đến mức không thể tin được, và ngay cả một người mới như tôi cũng có thể phát triển ứng dụng sử dụng API phức tạp một cách suôn sẻ.
Với sự phát triển của Apidog MCP Server, chúng ta có thể mong đợi các tính năng mạnh mẽ hơn để tối ưu hóa quy trình phát triển API. Dù là nhà phát triển front-end hay back-end, sự kết hợp giữa AI và tài liệu API này sẽ nâng cao đáng kể năng suất của bạn.
Hãy thử ngay! Nếu bạn có ý kiến hoặc câu hỏi, hãy chia sẻ trong phần bình luận. Hãy cùng nhau tận hưởng thời đại phát triển với AI!