클로드 API 개발 프롬프트 - RESTful API 설계 및 구현 가이드
Claude로 RESTful API를 설계하고 구현하는 개발 프롬프트입니다. API 엔드포인트 설계, 요청/응답 스키마 정의, 인증/보안 구현, 에러 처리, API 문서화 등 전체 API 개발 라이프사이클을 지원합니다.
프롬프트 사용 방법
- 1단계: 아래 입력 칸에 각 항목에 맞는 정보를 적어주세요
- 2단계: 입력하면 아래 프롬프트가 자동으로 업데이트됩니다
- 3단계: '프롬프트 복사' 버튼을 눌러 ChatGPT/Claude에 붙여넣으세요
💡 입력 칸의 회색 글씨는 예시입니다. 참고해서 작성해보세요!
📝 필요한 정보를 입력해주세요 (총 10개)
API 이름에 대한 값을 입력하세요
목적에 대한 값을 입력하세요
기술 스택
데이터베이스에 대한 값을 입력하세요
사용자 인증 방식
예상 트래픽 규모
리소스에 대한 값을 입력하세요
주요 기능에 대한 값을 입력하세요
준수해야 할 보안 규정
특별 요구사항에 대한 값을 입력하세요
📋 완성된 프롬프트 (복사해서 사용하세요)
당신은 FAANG 출신 수석 백엔드 아키텍트입니다. 15년간 대규모 분산 시스템을 설계해 온 전문가로서, 업계 표준을 준수하는 고품질 RESTful API를 설계해 주세요.
REST 설계 원칙, 에러 응답, 인증·인가와 OpenAPI 문서를 아래 요구사항에 맞게 검토하세요. 개선 효과를 단정하지 말고 검증할 테스트와 측정 방법을 함께 제안하세요.
## 프로젝트 개요
- API 이름: {{API_이름}}
- 목적: {{목적}}
- 기술 스택: {{기술_스택}}
- 데이터베이스: {{데이터베이스}}
- 인증 방식: {{인증_방식}}
- 예상 트래픽: {{예상_트래픽}}
## 핵심 리소스
{{리소스}}
## 주요 기능
{{주요_기능}}
## 보안 요구사항
{{보안_요구사항}}
## 특별 요구사항
{{특별_요구사항}}
## 출력 형식
1. API 개요 (목적, 기술 스택, 아키텍처)
2. 리소스 모델 (다이어그램 및 관계)
3. 엔드포인트 목록 (모든 엔드포인트와 설명)
4. 인증/인가 설계 (보안 구현 상세)
5. 요청/응답 스키마 (JSON 스키마 예시)
6. 에러 처리 (에러 코드 및 처리 방안)
7. 보안 고려사항 (체크리스트) 입력하지 않은 항목은 원래 표시를 유지합니다.
자동 복사를 사용할 수 없습니다. 아래 선택된 내용을 Ctrl+C 또는 ⌘C로 복사하거나, 길게 눌러 복사하세요.
간단 버전
다음 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 |
| 특별 요구사항 | 그 외 추가로 필요한 기능이 있으면 적어주세요 | 예: 실시간 검색 자동완성 | 실시간 검색 자동완성, 이미지 첨부, 캐싱, 로깅 |
인풋 필드
[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: "예: 실시간 검색 자동완성, 이미지 첨부"
설명: 그 외 추가로 필요한 기능이 있으면 적어주세요
HTTP 메서드
| 메서드 | 용도 | 멱등성 |
|---|---|---|
| GET | 조회 | ✓ |
| POST | 생성 | ✗ |
| PUT | 전체 수정 | ✓ |
| PATCH | 부분 수정 | ✗ |
| DELETE | 삭제 | ✓ |
상태 코드
| 코드 | 의미 |
|---|---|
| 200 | 성공 |
| 201 | 생성됨 |
| 400 | 잘못된 요청 |
| 401 | 인증 안됨 |
| 404 | 찾을 수 없음 |
| 500 | 서버 에러 |
URL 설계 규칙
- 명사, 소문자, 복수형 사용:
/users - 동사, 단수형, 대문자 지양:
/getUsers,/User - 중첩 레벨 최소화: 최대 3레벨
🚀 AI 바로 열기
🔗 관련 프롬프트
클로드 디버깅 프롬프트 - 코드 오류 분석 및 해결 가이드
Claude로 코드 오류 분석, 버그 수정, 에러 해결을 수행하는 프롬프트입니다. 다양한 언어의 런타임 에러, 논리 오류, 성능 이슈를 체계적으로 분석하고 해결합니다.
클로드 리팩토링 가이드 프롬프트 - 코드 품질 개선 및 최적화
Claude로 코드 리팩토링, 성능 최적화, 기술 부채 해결을 수행하는 프롬프트입니다. 유지보수성과 가독성을 높이는 전문적인 코드 개선 가이드입니다.
클로드 시스템 설계 문서 프롬프트 - 아키텍처 설계 가이드
Claude로 시스템 아키텍처 설계, 기술 스택 결정, API 설계, 인프라 계획 등을 문서화하는 프롬프트입니다. 확장 가능하고 유지보수 가능한 시스템 설계 문서를 작성합니다.
ChatGPT API 엔드포인트 설계 프롬프트 - RESTful/GraphQL API
ChatGPT로 RESTful API와 GraphQL API 엔드포인트를 설계하는 프롬프트입니다. HTTP 메서드, 상태 코드, 인증까지 체계적인 API 설계 방법을 안내합니다.