바로 쓸 수 있는 API 레퍼런스 작성하기
코드와 예시로 오류 코드와 동작하는 호출이 있는 엔드포인트별 레퍼런스를 쓰는 프롬프트. 원하는 AI 도구에 붙여 넣으면 AI가 API 레퍼런스를 작성하는.
결과는 도구, 모델, 입력한 내용에 따라 달라집니다.
결과 미리보기
예시: 저희 편집팀이 쓴 것으로, 실제 AI 출력이 아닙니다.
## POST /orders 주문을 생성합니다. | 항목 | 타입 | 필수 | 참고 | | customer_id | 문자열 | 예 | GET /customers에서 | | items | 목록 | 예 | 1개 이상 | | coupon | 문자열 | 아니요 | 대문자 | 오류: 409 = 이미 사용한 쿠폰 → 쿠폰 없이 다시 전송 열린 질문: 분당 100회 한도는 키별인가요, 계정별인가요?
채워 넣기
입력한 내용은 이 브라우저 창 안에만 머뭅니다. 저희는 아무것도 저장하거나 전송하지 않습니다.
어떤 API인가요?
- 온라인 쇼핑몰의 REST API
- 두 서비스 사이의 내부 API
- 협력사용 API
- 웹훅 API
- GraphQL API
무엇이 있나요?
- 라우트 소스 코드
- 기존 OpenAPI 파일
- 호출 예시 모음
- 텍스트로 된 예전 문서
- 팀 메모뿐
누가 읽나요?
- 고객사의 개발팀
- 우리 팀의 새 구성원
- 사전 지식이 없는 협력사
- 지원팀
- 사내 프런트엔드팀
내 프롬프트
프롬프트를 직접 수정했습니다. 위 입력란을 바꿔도 더 이상 덮어쓰지 않습니다.
이것은 AI에게 주는 지시문이며, 아직 결과물이 아닙니다.
이 프롬프트가 잘 맞는 도구
이 프롬프트에 잘 맞는 AI 도구:
사용 방법
- 항목을 채우거나 추천 문구를 누르세요. 이름, 주소 같은 개인 정보는 넣지 마세요.
- 완성된 프롬프트를 원하는 AI 도구에 붙여 넣으세요.
- API를 모르는 사람에게 레퍼런스만 건네 보세요. 질문 없이 첫 호출에 성공하면 좋은 레퍼런스입니다.
왜 효과가 있을까요?
레퍼런스가 실패하는 이유는 엔드포인트 누락보다 빠진 오류 코드, 모호한 필수 항목, 동작하지 않는 예시인 경우가 많습니다. 엔드포인트마다 정해진 구성과, 추측 대신 열린 질문을 남기는 방식이 신뢰도를 높입니다.
팁
- 자료를 AI 도구에 넣기 전에 예시의 키, 토큰, 고객 데이터를 자리표시자로 바꾸세요.