클로드 API 문서 작성 프롬프트 - 개발자용 기술 문서

간단 버전

{{메서드}} {{엔드포인트}} 엔드포인트 문서를 작성해주세요.

설명: {{설명}}
파라미터: {{파라미터}}

요청/응답 예시와 cURL, JavaScript 예제를 포함해주세요.

입력값 가이드

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

인풋 필드

[API 이름]
▼ 텍스트 입력
placeholder: "예: 사용자 관리 REST API"
설명: 문서화할 API의 이름을 지어주세요

[버전]
▼ 텍스트 입력
placeholder: "v1.0.0"
설명: 현재 API 버전을 적어주세요

[목적]
▼ 텍스트 영역 입력
placeholder: "예: 사용자 회원가입, 로그인, 프로필 관리"
설명: 이 API가 제공하는 핵심 기능을 설명해주세요

[대상 개발자]
▼ 드롭다운 선택
옵션: 프론트엔드 개발팀, 백엔드 개발팀, 외부 파트너, 내부 개발팀
placeholder: "프론트엔드 개발팀"
설명: 이 문서를 읽을 개발자층을 적어주세요

[기본 URL]
▼ 텍스트 입력
placeholder: "예: https://api.example.com"
설명: API 서버의 기본 주소를 적어주세요

[인증 방식]
▼ 드롭다운 선택
옵션: Bearer Token, API Key, OAuth 2.0, Basic Auth, 인증 없음
placeholder: "Bearer Token"
설명: 사용자 인증 방식을 적어주세요

[엔드포인트 목록]
▼ 텍스트 영역 입력
placeholder: "예: GET /users, POST /users, GET /users/:id"
설명: 문서화할 API 경로들을 나열해주세요

[리소스 필드]
▼ 텍스트 영역 입력
placeholder: "예: id, name, email, created_at"
설명: 주요 데이터 필드들을 적어주세요

[에러 코드]
▼ 텍스트 영역 입력
placeholder: "예: 400(잘못된 요청), 401(인증 필요), 404(없음)"
설명: 처리할 에러 상황들을 적어주세요

[예제 언어]
▼ 라디오 버튼 선택
옵션: ☐ cURL  ☐ JavaScript  ☐ Python  ☐ Java
placeholder: "JavaScript"
설명: 예제 코드를 작성할 프로그래밍 언어를 적어주세요

엔드포인트 문서 형식

## 엔드포인트명

`METHOD /path/to/endpoint`

### 설명
엔드포인트 기능 설명

### 요청 파라미터
| 이름 | 타입 | 필수 | 설명 |
|------|------|------|------|

### 응답 예시
성공/실패 케이스별 JSON 예시

### 코드 예제
cURL, JavaScript, Python 예제

에러 코드

주의사항