개발

API 문서 자동 생성

개발자 친화적인 API 문서와 사용 예제

API문서개발문서화
198
개발
프롬프트 템플릿
아래 템플릿을 복사해서 ChatGPT나 다른 AI 도구에 붙여넣어 사용하세요.
다음 API에 대한 문서를 작성해주세요: ``` [API 코드 또는 스펙 붙여넣기] ``` API 유형: [REST/GraphQL/gRPC] 버전: [버전] ## 📚 API 문서 ### 📋 개요 - **API명:** [API명] - **버전:** [버전] - **베이스 URL:** `[URL]` - **인증 방식:** [Bearer Token/API Key/OAuth] ### 🔐 인증 ```http Authorization: Bearer YOUR_API_KEY Content-Type: application/json ``` ### 📡 엔드포인트 #### GET /api/[endpoint] **설명:** [엔드포인트 설명] **요청 파라미터:** | 파라미터 | 타입 | 필수 | 설명 | |----------|------|------|------| | [param1] | string | ✅ | [설명] | | [param2] | number | ❌ | [설명] | **요청 예시:** ```bash curl -X GET "[URL]/api/[endpoint]?param1=value" \ -H "Authorization: Bearer YOUR_API_KEY" ``` **응답 예시:** ```json { "status": "success", "data": { "id": 1, "name": "example" } } ``` #### POST /api/[endpoint] **설명:** [엔드포인트 설명] **요청 바디:** ```json { "field1": "string", "field2": 123 } ``` **응답 코드:** - `200` - 성공 - `400` - 잘못된 요청 - `401` - 인증 실패 - `500` - 서버 오류 ### 🔧 SDK 예제 #### JavaScript ```javascript const response = await fetch('[URL]/api/[endpoint]', { method: 'GET', headers: { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' } }); const data = await response.json(); console.log(data); ``` #### Python ```python import requests headers = { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' } response = requests.get('[URL]/api/[endpoint]', headers=headers) data = response.json() print(data) ``` ### ⚠️ 에러 처리 ```json { "status": "error", "error": { "code": "INVALID_PARAMETER", "message": "The parameter 'id' is required" } } ``` ### 📊 Rate Limiting - **제한:** 1000 requests/hour - **헤더:** `X-RateLimit-Remaining` ### 🔄 버전 관리 - **현재 버전:** v1 - **지원 버전:** v1 - **deprecated:** 없음
사용 팁

1. 맥락 정보 추가

프롬프트의 대괄호 [ ] 부분을 실제 상황에 맞는 구체적인 정보로 교체하세요.

2. 단계별 실행

복잡한 작업의 경우 프롬프트를 여러 단계로 나누어 실행하면 더 좋은 결과를 얻을 수 있습니다.

3. 결과 검토

AI가 생성한 결과를 항상 검토하고 필요에 따라 수정하여 사용하세요.