API 탐색
API 엔드포인트를 탐색하고 검색하는 도구입니다.
swagger_list_endpoints
현재 서비스의 모든 API 엔드포인트를 나열합니다.
파라미터:
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
tag | string | 아니오 | 태그로 엔드포인트 필터링 |
예시 프롬프트:
- "모든 엔드포인트 보여줘"
- "'pet' 태그가 달린 엔드포인트만 보여줘"
- "어떤 엔드포인트가 있어?"
응답 내용:
- HTTP 메서드 (GET, POST, PUT, DELETE 등)
- 경로
- 요약
- 태그
- Deprecated 여부
실제 사용 예시:
사용자: pet 관련 엔드포인트 보여줘
Claude: [swagger_list_endpoints tag="pet"]
🏷️ "pet" 태그 8개 엔드포인트:
| 메서드 | 경로 | 요약 |
|--------|------|------|
| POST | /pet | 새 펫 추가 |
| PUT | /pet | 펫 수정 |
| GET | /pet/findByStatus | 상태로 검색 |
| GET | /pet/{petId} | ID로 조회 |
| DELETE | /pet/{petId} | 펫 삭제 |
...swagger_get_endpoint
특정 엔드포인트의 상세 정보를 가져옵니다.
파라미터:
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
method | string | 예 | HTTP 메서드 (get, post, put, delete, patch, options, head) |
path | string | 예 | 엔드포인트 경로 (예: /users/{id}) |
예시 프롬프트:
- "GET /pet/{petId} 상세 정보 보여줘"
- "POST /pet에 어떤 파라미터가 필요해?"
- "DELETE /pet/{petId} 엔드포인트 설명해줘"
응답 내용:
- 전체 엔드포인트 메타데이터
- Path, Query, Header 파라미터
- 요청 바디 스키마
- 모든 상태 코드에 대한 응답 스키마
- 보안 요구사항
실제 사용 예시:
사용자: POST /pet 상세 정보 알려줘
Claude: [swagger_get_endpoint method="post" path="/pet"]
📖 POST /pet - 스토어에 새 펫 추가
요청 바디 (application/json):
{
"name": string (필수),
"photoUrls": string[] (필수),
"status": "available" | "pending" | "sold"
}
응답:
- 200: 성공
- 405: 잘못된 입력swagger_search
키워드로 엔드포인트를 검색합니다.
파라미터:
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
keyword | string | 예 | 검색 키워드 (대소문자 구분 없음) |
예시 프롬프트:
- "API에서 'user' 검색해줘"
- "인증 관련 엔드포인트 찾아줘"
- "'order' 언급된 엔드포인트가 뭐야?"
검색 대상:
- 경로
- 요약
- 설명
- Operation ID
- 태그
실제 사용 예시:
사용자: API에서 'status' 검색해줘
Claude: [swagger_search keyword="status"]
🔍 "status" 검색 결과 3개:
| 메서드 | 경로 | 요약 |
|--------|------|------|
| GET | /pet/findByStatus | 상태로 펫 검색 |
| GET | /store/order/{orderId} | 주문 ID로 조회 |
| POST | /pet/{petId} | 펫 상태 업데이트 |