Apidog MCP 활용 가이드

이 가이드는 Apidog MCP Server를 설치한 후 API 개발 과정에서 어떻게 활용할 수 있는지 설명합니다. AI 어시스턴트와 API 사양의 상호작용을 최대한 활용하는 방법을 알아봅니다.

기본 기능 활용하기

Apidog MCP Server가 설치되면, Claude와 같은 AI 어시스턴트에게 다음과 같은 작업을 요청할 수 있습니다:

API 사양에서 "사용자" 관련 엔드포인트를 보여줘.

"결제" 스키마의 모든 필드와 타입을 알려줘.

"주문" 스키마에 대한 Java 레코드를 생성해줘.

"인증" 엔드포인트에 대한 클라이언트 코드를 JavaScript로 작성해줘.

"제품" API에 대한 Spring 컨트롤러 전체를 생성해줘.

API 사양에 따라 "사용자" DTO에 "discountCode" 필드를 추가해줘.

"결제" 서비스 인터페이스를 최신 API 변경 사항에 맞게 업데이트해줘.

API 사양에 따라 "ProductService" 메소드에 Javadoc 주석을 추가해줘.

"인증" 컨트롤러에 API 사양의 설명을 기반으로 문서 블록을 추가해줘.

결제 관련 엔드포인트가 있는지 검색해줘.

"created_at" 필드를 사용하는 모든 스키마를 찾아줘.

Apidog MCP Server는 API 개발 프로세스 전반에 걸쳐 다양한 단계에서 도움을 줄 수 있습니다:

API 사양을 분석하고 개선할 점이나 모범 사례에 맞지 않는 부분을 알려줘.

"사용자" 스키마에 누락된 필수 필드가 있는지 확인해줘.

이 API 사양에 맞는 TypeScript 인터페이스와 클라이언트 함수를 모두 생성해줘.

이 API 엔드포인트에 맞는 Express 라우터를 생성하고 필요한 유효성 검사도 추가해줘.

API 사양에 따라 "제품" 엔드포인트에 대한 Jest 테스트 코드를 작성해줘.

API 요청과 응답을 검증하는 테스트 케이스를 생성해줘.

API 문서에 대한 마크다운 요약을 생성해줘.

각 엔드포인트에 대한 사용 예시 코드를 생성해줘.

프로젝트 내 모든 API 엔드포인트 목록을 보여줘.

API 사양의 최신 변경 사항을 가져와줘.

문서에서 권한 부여 방법을 설명하는 부분을 찾아줘.

API 문서의 "시작하기" 섹션에서 핵심 내용을 요약해줘.

Swagger 파일의 모든 경로와 메소드를 나열해줘.

OpenAPI 파일의 보안 스키마를 분석해줘.

최신 상태 유지하기: API 사양이 업데이트되면 "API 사양을 새로고침해줘"라고 요청하여 캐시를 업데이트합니다.
상세한 요청하기: "결제 API에 대한 코드 생성해줘" 보다는 "결제 API의 POST /payments 엔드포인트에 대한 JavaScript Fetch 함수를 생성해줘"처럼 구체적으로 요청하세요.
맥락 제공하기: "이 코드는 Spring Boot 3.1 환경에서 사용될 예정이야"와 같이 필요한 맥락을 제공하면 더 적합한 코드가 생성됩니다.
증분적 작업하기: 대규모 코드베이스를 한 번에 생성하기보다는 작은 단위로 나누어 생성하고 테스트하세요.
API 설계 개선하기: AI에게 API 설계의 문제점이나 개선점을 분석해달라고 요청할 수 있습니다.