AI 프롬프트 상세
실제 비즈니스 문제를 더 빠르게 해결하도록 설계된 실용적이고 바로 사용할 수 있는 AI 프롬프트입니다. 명확한 단계, 검증된 프레임워크, 즉시 실행 가능한 전략을 제공합니다.
배포 전 API 엔드포인트 검증 및 개선하기
불명확한 응답, 누락된 필드, 예외 케이스가 사용자에게 도달하기 전에 미리 잡아내세요.
해결하는 문제
개발자들은 기술적으로는 작동하지만 프론트엔드 팀이나 외부 사용자에게 혼란을 주는 API를 배포하곤 합니다. 누락된 오류 케이스, 일관성 없는 응답, 모호한 명명법은 버그와 재작업의 원인이 됩니다.
규약(Contract) 수준 검증
사용자 관점에서 API를 검토합니다.
오류 우선 사고
실제 환경에서 발생할 수 있는 실패 시나리오를 조기에 찾아냅니다.
통합 친화적 출력
API를 더 사용하기 쉽고 디버깅하기 쉽게 만듭니다.
AI 프롬프트 사용 방법
시니어 백엔드 엔지니어이자 API 리뷰어로서 행동해 주세요.
API 엔드포인트 (메서드 + 경로): [예: POST /api/orders]
엔드포인트 목적: [수행하는 작업]
요청 페이로드 (JSON): [붙여넣기]
성공 응답 예시 (JSON): [붙여넣기]
알려진 오류 케이스 (있는 경우): [나열하거나 없음]
당신의 임무:
1) API 명세에서 엔드포인트의 목적이 명확한지 확인하세요.
2) 누락되거나 모호한 요청 필드를 식별하세요.
3) 일관성과 명확성을 위해 응답 구조를 검토하세요.
4) 상태 코드가 포함된 최소 3가지의 현실적인 오류 응답을 제안하세요.
5) 이름 지정이나 구조에 대한 사소한 개선 사항을 추천하세요.
6) 최종적으로 개선된 응답 예시를 출력하세요.
피드백은 실용적이고 즉시 구현 가능해야 합니다. API 전체를 재설계하지 마세요.
예상 결과
명확한 개선 제안, 누락된 오류 케이스, 그리고 더 깔끔해진 응답 예시를 받게 됩니다.
구현 여정
엔드포인트 세부 정보 붙여넣기
하나의 API 엔드포인트의 요청, 응답 및 목적을 추가합니다.
3분AI 피드백 검토
제안된 수정 사항과 누락된 예외 케이스를 확인합니다.
3분배포 전 적용
출시 전 엔드포인트나 문서를 업데이트합니다.
5분프롬프트 개요
엔드포인트 하나가 깔끔해지면, 다음 단계는 전체 API 설계의 유효성을 검토하고 규약(Contract) 체크를 자동화하는 것입니다.
이 프롬프트를 이메일로 보내기
이 AI 프롬프트를 깔끔하고 복사하기 쉬운 형태로 받은편지함에 보내드립니다. 언제든지 사용할 수 있어요.