본문으로 건너뛰기
Claude Opus 4.54.8 · 5,600 회 사용

API 문서 생성기

코드나 엔드포인트 설명에서 명확하고 구조화된 API 문서를 생성합니다.

프롬프트 내용

다음 엔드포인트에 대한 API 문서를 생성해 주세요.

엔드포인트: [URL과 메서드]
인증: [유형]
요청 본문: [스키마 또는 예시]
응답: [스키마 또는 예시]

포함 항목:
1. 간단한 설명
2. 요청 매개변수(path, query, body)
3. 상태 코드가 포함된 응답 형식
4. 요청/응답 예시
5. 오류 코드 및 처리 참고사항

OpenAPI/Swagger 통합에 적합한 Markdown 형식으로.

사용 방법

프롬프트를 복사한 뒤 [대괄호 자리 표시자]를 자신의 내용으로 바꾸고 평소 쓰는 AI 도구에 붙여넣으세요. 작업에 맞게 어조나 범위를 조절해도 좋습니다.

모델
Claude Opus 4.5
평점
4.8 / 5
API 문서문서개발자

관련 프롬프트