최근에는 저와 같은 초보 프로그래머도 AI의 힘으로 전문가 수준의 코드를 작성할 수 있게 되었습니다. 하지만 API 개발에 있어서는 API 명세서를 참조하며 꼼꼼하게 코드를 작성해야 하는 것이... 솔직히 말하자면 꽤 번거롭습니다(웃음).
최근 저는 Cursor와 Apidog MCP Server의 조합을 발견했습니다. 정말 놀라웠어요! AI가 API 명세서를 직접 읽고 자동으로 코드를 생성할 수 있게 해줍니다. "어, 그런 것도 가능해?"라고 생각하실 수 있겠죠. 오늘은 이 충격적인 경험을 여러분과 공유하려고 합니다!
MCP(Model Context Protocol)는 AI를 외부 데이터 소스와 연결하는 프로토콜입니다. 간단히 말하면, AI 애플리케이션을 위한 표준 인터페이스를 설정하여 다양한 데이터 소스와 도구에 쉽게 연결할 수 있게 해줍니다.
Apidog MCP Server를 사용하면 Apidog 프로젝트의 API 문서를 Cursor와 같은 AI 지원 IDE의 데이터 소스로 제공할 수 있습니다. 이를 통해 AI가 프로젝트의 API 문서 데이터에 직접 접근할 수 있습니다.
개발자는 AI 어시스턴트를 통해 API 문서를 기반으로 코드를 생성하거나 수정하고, API 문서 내용을 검색하는 등의 작업을 수행할 수 있습니다. 솔직히 말해서, 이 메커니즘으로 AI가 할 수 있는 놀라운 일들은 여러분의 상상력에 의해서만 제한됩니다!
Apidog MCP Server는 3가지 사용 방법이 있습니다:
1) Apidog Access Token 얻기
2) Apidog 프로젝트 ID 얻기
전역 설정(권장) 또는 프로젝트 설정으로 구성할 수 있습니다.
전역 설정의 경우:
1) Cursor를 열고, 오른쪽 상단의 "설정" 아이콘을 클릭한 다음 왼쪽에서 "MCP" 옵션을 선택하고 "+ Add new global MCP server" 버튼을 클릭합니다.
2) 열린 mcp.json
파일에 다음 구성을 추가합니다 (<access-token>
과 <project-id>
를 자신의 값으로 대체):
{
"mcpServers": {
"API specification": {
"command": "npx",
"args": [
"-y",
"apidog-mcp-server@latest",
"--project-id=<project-id>"
],
"env": {
"APIDOG_ACCESS_TOKEN": "<access-token>"
}
}
}
}
Windows를 사용하는 경우 다음과 같은 구성이 필요할 수 있습니다:
{
"mcpServers": {
"API specification": {
"command": "cmd",
"args": [
"/c",
"npx",
"-y",
"apidog-mcp-server@latest",
"--project-id=<project-id>"
],
"env": {
"APIDOG_ACCESS_TOKEN": "<access-token>"
}
}
}
}
프로젝트 설정의 경우:
1) 프로젝트 루트 디렉토리에 .cursor
폴더 생성
2) 해당 폴더에 mcp.json
파일 생성
3) 위와 동일한 구성 사용
설정을 완료한 후, AI에게 물어보면 연결이 정상적으로 작동하는지 확인할 수 있습니다(Agent 모드):
MCP를 통해 API 문서를 가져와서 프로젝트에 API가 몇 개 있는지 알려주세요
AI가 Apidog 프로젝트의 API 정보를 반환하면 연결이 성공한 것입니다!
전자상거래 사이트를 개발 중이고 API 문서에 제품 관련 인터페이스와 데이터 구조가 정의되어 있다고 가정해 봅시다.
단계:
1) Cursor를 열고 새 프로젝트 생성
2) AI에게 다음과 같이 요청:
MCP를 통해 API 문서를 가져와서 제품 관련 API에 대한 완전한 TypeScript 인터페이스 정의와 서비스 클래스를 생성해 주세요
AI는 다음을 수행합니다:
1) MCP를 통해 API 문서 읽기
2) 제품 관련 인터페이스 및 데이터 구조 분석
3) API 명세에 맞는 TypeScript 인터페이스 및 서비스 클래스 코드 생성
API 문서가 업데이트되면 코드도 동기화하여 업데이트해야 합니다.
단계:
1) Apidog에서 제품 API를 업데이트하고, 새 필드 discountPrice
추가
2) AI에게 코드 업데이트 요청:
API 문서가 업데이트되었습니다. MCP 캐시를 새로고침하고 Product 인터페이스를 업데이트하여 API 문서의 새 필드를 추가해 주세요
AI는 다음을 수행합니다:
1) MCP 캐시를 새로고침하여 최신 API 문서 가져오기
2) 새 필드 discountPrice
식별
3) Product 인터페이스 코드 업데이트
예시:
export interface Product {
id: string;
name: string;
description: string;
price: number;
discountPrice?: number; // 새 필드
category: string;
imageUrls: string[];
inStock: boolean;
createdAt: string;
updatedAt: string;
}
백엔드 개발자의 경우, API 문서에서 Controller, Service 및 Repository 코드를 자동으로 생성할 수 있습니다.
단계:
다음과 같이 AI에게 요청하기만 하면 됩니다:
API 문서를 기반으로 사용자 관리 모듈에 대한 Controller, Service 및 Repository를 포함한 완전한 Spring Boot MVC 코드를 생성해 주세요
AI는 API 명세에 맞는 완전한 Spring Boot 코드 구조를 생성합니다. 편리하지 않나요!
복잡한 API 문서를 검색하고 이해하기 위해 AI를 사용할 수 있습니다.
예시:
API 문서에서 결제와 관련된 모든 인터페이스를 찾고 그들의 관계와 사용 프로세스를 설명해 주세요
AI는 다음을 수행합니다:
1) MCP를 통해 API 문서에서 결제 관련 인터페이스 검색
2) 이러한 인터페이스 간의 관계 분석
3) 결제 프로세스를 이해하기 쉽게 설명
단계:
AI에게 테스트 코드 생성 요청:
MCP의 API 문서를 기반으로 Jest 프레임워크를 사용하여 제품 생성 인터페이스에 대한 완전한 단위 및 통합 테스트 코드를 생성해 주세요
AI는 API 명세에 맞는 테스트 코드를 생성하며, 정상 케이스와 다양한 경계 조건을 포함합니다. 이는 테스트 작성의 번거로움을 해결해 줍니다!
동일한 개발 환경에서 여러 Apidog 프로젝트의 API 문서를 사용하려면 MCP 구성에 여러 서비스를 추가할 수 있습니다:
{
"mcpServers": {
"마켓플레이스 API 명세": {
"command": "npx",
"args": [
"-y",
"apidog-mcp-server@latest",
"--project=<project-id>"
],
"env": {
"APIDOG_ACCESS_TOKEN": "<access-token>"
}
},
"CRM API 명세": {
"command": "npx",
"args": [
"-y",
"apidog-mcp-server@latest",
"--project=<project-id>"
],
"env": {
"APIDOG_ACCESS_TOKEN": "<access-token>"
}
}
}
}
AI에게 질문할 때 어떤 API 문서를 사용하고 싶은지 명확히 지정하세요:
마켓플레이스 API 명세를 사용하여 주문 관리 모듈에 대한 코드를 생성해 주세요
팀 작업 시 Access Token 공유를 피하기 위해:
1) 구성 파일에서 "APIDOG_ACCESS_TOKEN": "<access-token>"
부분 제거
2) 각 개발자의 시스템에서 APIDOG_ACCESS_TOKEN
환경 변수 설정
Apidog MCP Server와 Cursor의 결합은 전례 없는 놀라운 API 개발 경험을 제공합니다. AI가 API 문서에 직접 접근할 수 있게 함으로써 다음과 같은 이점을 얻을 수 있습니다:
1) API 명세에서 코드 구현까지의 시간을 크게 단축
2) 인적 오류 가능성 감소
3) 반복 및 업데이트 프로세스 가속화
4) 코드 품질 및 일관성 향상
솔직히 말해서, 예전에는 API 문서를 참조하는 데 몇 시간씩 소비했던 시간이 이제는 믿을 수 없을 정도로 줄어들었고, 저와 같은 초보자도 복잡한 API를 사용하는 애플리케이션을 원활하게 개발할 수 있게 되었습니다.
Apidog MCP Server의 발전과 함께, API 개발 프로세스를 최적화하기 위한 더 강력한 기능들이 등장할 것으로 기대할 수 있습니다. 프론트엔드 개발자든 백엔드 개발자든, AI와 API 문서의 이러한 결합은 여러분의 생산성을 크게 향상시킬 것입니다.
지금 바로 시도해 보세요! 의견이나 질문이 있으시면 댓글로 공유해 주세요. 함께 AI와 함께하는 개발 시대를 즐겨봅시다!