API 레퍼런스 문서를 작성하는 프롬프트

언제 사용하나

엔드포인트의 요청/응답을 소비자가 바로 쓸 수 있게 문서화할 때.

요청 전 확인

• 실제 엔드포인트 시그니처, 상태 코드, 예시 값을 확보한다.

복사해서 쓰는 프롬프트

아래 엔드포인트의 API 레퍼런스를 작성해줘.

엔드포인트/코드: {{ENDPOINT}}

각 엔드포인트마다:
1. 목적과 인증 요구
2. 요청(경로/쿼리/바디)과 필드 설명·필수 여부
3. 성공 응답 예시와 주요 에러 응답(상태 코드·의미)
4. 복사 가능한 curl 예시(실제 토큰 대신 {{TOKEN}})
5. 주의사항(레이트 리밋, 페이지네이션)

placeholder 설명

• {{ENDPOINT}} : 엔드포인트 정의/코드

입력 예시

{{ENDPOINT}} = "GET /api/posts?category=..."

기대 결과

요청/응답/에러/curl이 정리된 레퍼런스.

검증 방법

문서의 curl을 실제로 실행해 응답과 일치하는지 확인한다.

주의사항

• 문서와 실제 응답이 어긋나면 소비자 신뢰가 깨진다.

관련 문서

• OpenAPI 명세: https://swagger.io/specification/