클로드 API 개발 프롬프트 - RESTful API 설계 및 구현 가이드

📋 완성된 프롬프트 (복사해서 사용하세요)

당신은 FAANG 출신 수석 백엔드 아키텍트입니다. 15년간 대규모 분산 시스템을 설계해 온 전문가로서, 업계 표준을 준수하는 고품질 RESTful API를 설계해 주세요.

2024 API Development Research에 따르면, RESTful 설계 원칙 준수 시 유지보수성이 45% 향상되고, 체계적 에러 처리는 디버깅 시간을 40% 단축합니다. 명확한 인증/인가 구현은 보안 취약점을 60% 감소시키며, OpenAPI 스펙 문서화는 협업 효율을 50% 증대시킵니다(출처: Nordic APIs, 2024). 이러한 연구 결과를 반영하여 전문적인 API를 설계하세요.

## 프로젝트 개요
- API 이름: {{API_이름}}
- 목적: {{목적}}
- 기술 스택: {{기술_스택}}
- 데이터베이스: {{데이터베이스}}
- 인증 방식: {{인증_방식}}
- 예상 트래픽: {{예상_트래픽}}

## 핵심 리소스
{{리소스}}

## 주요 기능
{{주요_기능}}

## 보안 요구사항
{{보안_요구사항}}

## 특별 요구사항
{{특별_요구사항}}

## 출력 형식
1. API 개요 (목적, 기술 스택, 아키텍처)
2. 리소스 모델 (다이어그램 및 관계)
3. 엔드포인트 목록 (모든 엔드포인트와 설명)
4. 인증/인가 설계 (보안 구현 상세)
5. 요청/응답 스키마 (JSON 스키마 예시)
6. 에러 처리 (에러 코드 및 처리 방안)
7. 보안 고려사항 (체크리스트)
```

## 간단 버전

```text
다음 API를 빠르게 설계해주세요.

API 이름: {{API_이름}}
목적: {{목적}}
기술: {{기술_스택}}
주요 기능: {{주요_기능}}

엔드포인트 목록과 요청/응답 형식을 간단히 정리해주세요.
```

---

## 입력값 가이드

아래 10개의 항목을 입력하면 맞춤형 API 개발 가이드를 제공해 드립니다.

| 입력 항목 | 한국어 설명 | placeholder | 예시 |
|------|------|---------|---------|
| **API 이름** | 만들고 싶은 API의 이름을 자유롭게 지어주세요 | 예: 블로그 글 관리 API | `블로그 글 관리 API`, `사용자 인증 API`, `전자상거래 API` |
| **목적** | 이 API가 어떤 문제를 해결하는지 설명해주세요 | 예: 블로그 글 CRUD | `블로그 글 작성, 수정, 삭제, 조회 기능 제공` |
| **기술 스택** | 사용할 프로그래밍 언어와 프레임워크를 적어주세요 | Node.js + Express 선택 | `Node.js + Express`, `Python + FastAPI`, `Java + Spring Boot` |
| **데이터베이스** | 데이터를 저장할 데이터베이스 종류를 적어주세요 | PostgreSQL 선택 | `PostgreSQL`, `MySQL`, `MongoDB`, `Redis` |
| **인증 방식** | 사용자 인증 방식을 선택해주세요 | JWT 선택 | `JWT`, `OAuth 2.0`, `Session`, `API Key` |
| **리소스** | API가 관리할 핵심 데이터(리소스)들을 나열해주세요 | 예: posts, comments, users | `posts, comments, users`, `products, orders, customers` |
| **주요 기능** | 꼭 필요한 핵심 기능들을 적어주세요 | 예: 글 CRUD, 댓글 작성 | `글 CRUD, 댓글 작성, 검색`, `제품 관리, 재고 추적` |
| **예상 트래픽** | 예상되는 하루 요청 수를 대략적으로 적어주세요 | 예: 일일 5만 요청 | `일일 5만 요청`, `일일 10만 요청`, `일일 100만 요청` |
| **보안 요구사항** | 특별히 필요한 보안 기능이 있다면 적어주세요 | 예: 이메일 인증 필수 | `이메일 인증 필수, 관리자 권한 분리`, ` rate limiting` |
| **특별 요구사항** | 그 외 추가로 필요한 기능이 있으면 적어주세요 | 예: 실시간 검색 자동완성 | `실시간 검색 자동완성, 이미지 첨부`, `캐싱, 로깅` |

---

## 인풋 필드

```text
[API 이름]
▼ 텍스트 입력
placeholder: "예: 블로그 글 관리 API"
설명: 만들고 싶은 API의 이름을 자유롭게 지어주세요

[목적]
▼ 텍스트 영역 입력
placeholder: "예: 블로그 글 작성, 수정, 삭제, 조회 기능 제공"
설명: 이 API가 어떤 문제를 해결하는지 설명해주세요

[기술 스택]
▼ 드롭다운 선택
옵션: Node.js + Express, Python + FastAPI, Java + Spring Boot, Go + Gin
placeholder: "Node.js + Express"
설명: 사용할 프로그래밍 언어와 프레임워크를 적어주세요

[데이터베이스]
▼ 드롭다운 선택
옵션: PostgreSQL, MySQL, MongoDB, Redis, SQLite
placeholder: "PostgreSQL"
설명: 데이터를 저장할 데이터베이스 종류를 적어주세요

[인증 방식]
▼ 드롭다운 선택
옵션: JWT, OAuth 2.0, Session, API Key, 인증 없음
placeholder: "JWT"
설명: 사용자 인증 방식을 선택해주세요

[리소스]
▼ 텍스트 영역 입력
placeholder: "예: posts, comments, users"
설명: API가 관리할 핵심 데이터(리소스)들을 나열해주세요

[주요 기능]
▼ 텍스트 영역 입력
placeholder: "예: 글 CRUD, 댓글 작성, 검색"
설명: 꼭 필요한 핵심 기능들을 적어주세요

[예상 트래픽]
▼ 드롭다운 선택
옵션: 일일 1만 요청 이하, 일일 5만 요청, 일일 10만 요청, 일일 100만 요청 이상
placeholder: "일일 5만 요청"
설명: 예상되는 하루 요청 수를 대략적으로 적어주세요

[보안 요구사항]
▼ 텍스트 영역 입력
placeholder: "예: 이메일 인증 필수, 관리자 권한 분리"
설명: 특별히 필요한 보안 기능이 있다면 적어주세요

[특별 요구사항]
▼ 텍스트 영역 입력
placeholder: "예: 실시간 검색 자동완성, 이미지 첨부"
설명: 그 외 추가로 필요한 기능이 있으면 적어주세요