개발자 (V)SEO OPTIMIZED PROMPT TEMPLATE
대규모 트래픽을 견디는 완벽한 RESTful API 설계 메가 프롬프트
API 규격을 매번 손으로 정의하시느라 시간을 낭비하셨나요? 이 프롬프트는 리소스 기반 URI 설계, 올바른 HTTP Status Code 매핑, 에러 응답 객체 표준화(RFC 7807), OpenAPI 스펙 초안까지 일체형으로 정의해 드립니다.
무료 배포 스타터 프롬프트 (Starter Template)
당신은 대규모 마이크로서비스 아키텍처(MSA)를 성공적으로 이끈 수석 백엔드 아키텍트입니다.
제시된 [비즈니스 도메인 및 기획 요구사항]을 만족하는 수준 높은 RESTful API 설계 보고서를 작성해 주세요.
1. **설계 규격:**
- **URI 설계 가이드:** 명사를 기반으로 한 리소스 지향 엔드포인트 목록 구성 (GET, POST, PUT, DELETE, PATCH)
- **HTTP 상태 코드:** 성공(200, 201), 클라이언트 에러(400, 401, 403, 404), 서버 에러(500) 매핑 기준 명시
- **에러 응답 규격:** RFC 7807 (Problem Details for HTTP APIs) 표준에 적합한 JSON 에러 구조 정의
- **OpenAPI 3.0 YAML:** Swagger 등에서 바로 임포트하여 API 문서 시각화가 가능한 YAML 규격 예시 포함
2. **입력값:**
- **도메인 주제:** [예: 커머스 주문 및 배송 관리 시스템, 예약 서비스 등]
- **핵심 엔티티(Entity):** [예: Order, Payment, Shipping]
글로벌 대기업 수준의 API 가이드라인을 확보하세요
- 1URI 구조 설계에 있어 완벽한 표준 가이드라인(kebab-case 사용, 복수형 리소스 등)을 적용합니다.
- 2에러 정의에 있어 업계 표준인 RFC 7807 스펙을 구현하여 클라이언트와의 완벽한 소통 규격 마련.
- 3OpenAPI 명세 기반의 인터페이스 설계로 프론트엔드와 백엔드의 생산성 시너지를 극대화.
💡 이 프롬프트를 200% 활용하는 팁 (Pro-Tips)
- 인증 방식(JWT, OAuth2 등)에 관한 부가 조건을 입력값에 포함해 보세요. 보안 토큰 처리 및 헤더 명세까지 완벽히 문서화해 줍니다.
- AI Handler 개발자(V) 모드에 도메인 기획을 추가해 설계해 보세요.
업무 생산성을 10배로 높일 준비가 되셨나요?
AI Handler 메인 엔진에 요구사항을 단 10초 만에 입력하여, 나의 구체적인 조건과 상황에 맞춤 설계된 고퀄리티 대용량 메가 프롬프트를 완전 자동 설계해 보세요.