기존 라우트로 API 명세 초안 만들기
기존 라우트와 예시로 열린 문제 목록이 붙은 OpenAPI 초안을 만드는 템플릿입니다. 원하는 AI 도구에 붙여 넣으면 AI가 API 명세 초안을 씁니다.
결과는 도구, 모델, 입력한 내용에 따라 달라집니다.
결과 미리보기
예시: 저희 편집팀이 쓴 것으로, 실제 AI 출력이 아닙니다.
paths: /orders/{id}: get: summary: 주문 한 건 조회 responses: "200": { $ref: "#/components/schemas/Order" } "404": { description: 주문을 찾을 수 없음 } 열린 문제: - status: 여기서는 "open", /orders에서는 "pending" - /refunds의 오류 형식 알 수 없음
채워 넣기
입력한 내용은 이 브라우저 창 안에만 머뭅니다. 저희는 아무것도 저장하거나 전송하지 않습니다.
어떤 API인가요?
- 주문과 상품을 다루는 쇼핑몰 백엔드
- 사용자 계정용 사내 서비스
- 개인 프로젝트의 작은 REST API
- 파트너용 API
- 웹훅 엔드포인트
무엇을 붙여 넣을 수 있나요?
- 코드의 라우트 정의
- 요청과 응답 예시
- 오래된 위키 페이지
- 개인정보가 없는 실제 호출 로그
- 이것들을 섞은 것
명세는 어디에 쓰나요?
- 파트너용 문서
- 클라이언트 생성
- 빌드 시 계약 점검
- 새 개발자 온보딩
- 첫 전체 파악
내 프롬프트
프롬프트를 직접 수정했습니다. 위 입력란을 바꿔도 더 이상 덮어쓰지 않습니다.
이것은 AI에게 주는 지시문이며, 아직 결과물이 아닙니다.
이 프롬프트가 잘 맞는 도구
이 프롬프트에 잘 맞는 AI 도구:
사용 방법
- 항목을 채우거나 추천 문구를 누르세요. 이름, 주소 같은 개인 정보는 넣지 마세요.
- 완성된 프롬프트를 원하는 AI 도구에 붙여 넣으세요.
- 예시는 지어낸 값으로 붙여 넣으세요. 실제 토큰과 고객 데이터는 자료에 넣지 마세요.
왜 효과가 있을까요?
코드에서 거꾸로 쓴 명세는 코드가 잘 돌아가는 동안 아무도 모르는 빈틈을 보여 줍니다. 문서화되지 않은 오류, 두 가지 뜻을 가진 필드, 패턴에서 벗어난 라우트 같은 것들입니다.
팁
- 공개하기 전에 실제로 동작하는 API와 초안을 대조하세요. 실제와 다른 명세는 없는 것보다 나쁩니다.