OpenAPI·cURL·응답 샘플로 AI용 API 문서 만들기

붙여넣을 수 있는 것

• OpenAPI(Swagger) 정의(JSON): 파일의 첫 번째 엔드포인트로 요청 값과 응답 칼럼을 채웁니다.
• cURL 명령: 주소 뒤 값(쿼리)과 JSON 본문으로 요청 값을 채웁니다.
• JSON 응답 샘플: 값에서 타입과 예시를 읽어 응답 칼럼을 채웁니다.
• TypeScript 인터페이스·타입: 속성으로 칼럼을 채웁니다.
• 엑셀·CSV 표: 명세 표(이름, 타입, 설명) 또는 실제 데이터 표.

순서대로 따라 하기

1. 1로그인 후 API 목록에서 API 등록하기를 누르고, 이름·요청 방식·기본 주소·경로를 채웁니다.
2. 2요청 값 또는 응답 칼럼 표에서 스마트 채우기를 누릅니다.
3. 3OpenAPI JSON, cURL 명령, 응답 샘플, TypeScript 타입, 표를 붙여넣습니다. 형식은 자동 감지되고, 직접 고를 수도 있습니다.
4. 4미리보기를 확인하고 추가를 누릅니다. 기존 칼럼은 그대로 두고, 같은 이름은 건너뜁니다.
5. 5API를 저장한 뒤 상세 화면에서 실제 응답을 붙여넣으면 문서에 샘플이 함께 들어갑니다.
6. 6문서 만들기에서 필요한 API를 골라 마크다운 문서를 복사해 ChatGPT, Claude, Cursor에 붙여넣습니다.

Postman 같은 API 클라이언트를 쓰고 있다면

Postman을 비롯한 대부분의 API 클라이언트는 요청을 cURL 명령으로 복사할 수 있습니다. 요청을 cURL로 복사해 스마트 채우기에 붙여넣으면 요청 값이 채워집니다. 응답 칼럼은 클라이언트에서 받은 실제 응답 본문을 붙여넣으세요.

예시: cURL 명령

curl "https://api.example.com/v1/forecast/hourly?zip=10001&date=2026-09-29" \
  -H "X-API-Key: YOUR_API_KEY"

스마트 채우기가 zip, date 쿼리 값을 찾아 요청 값 표에 추가합니다.

알아 두면 좋은 점

• 실제 응답을 붙여넣기 전에 이름, 전화번호, 이메일, 인증키는 가려 주세요.
• 칼럼마다 한 줄 설명을 적어 두세요. AI가 가장 많이 참고하는 부분입니다.
• 문서로 내보낼 때 긴 배열은 3건으로 줄여서 AI의 문맥 창이 금방 차지 않습니다.