API 설계·문서화 도우미

신규 예약 서비스 API 설계 초안

1인 개발 스타트업 창업자가 미용실 예약 앱의 백엔드 API를 어떻게 설계해야 할지 몰라 초안이 필요하다.

입력 예시
미용실 예약 서비스를 만들고 있습니다. 고객이 원하는 날짜·시간·디자이너를 선택해서 예약하고, 예약 취소도 가능해야 해요. 관리자는 예약 목록을 조회하고 상태(대기/확정/취소)를 변경할 수 있어야 합니다. API 설계해주세요.

결과 요약
적용된 기본값(REST·JWT 인증·/v1 버전 등) 명시, 예약 생성·조회·취소·상태변경 엔드포인트 명세, Mock 응답 예시, 정상/경계/에러 테스트 케이스가 담긴 문서를 받습니다.

기획자가 개발팀에 전달할 API 스펙 초안

PM이 개발자 없이 먼저 API 스펙 초안을 만들어 개발팀과 소통 자료로 쓰려 한다.

입력 예시
사내 도서 대출 관리 시스템 API가 필요합니다. 도서 등록/검색, 대출 신청, 반납 처리, 연체자 조회 기능이 있어야 해요. GraphQL로 설계해주고 인증은 API 키 방식으로 부탁해요.

결과 요약
GraphQL·API 키 인증이 반영된 스키마 설계, 쿼리·뮤테이션 명세, Mock 응답 예시, 테스트 케이스가 포함된 문서를 받아 개발팀과 바로 논의할 수 있습니다.

결제 연동 전 내부 API 스펙 정리

소규모 쇼핑몰 운영팀이 자체 포인트 적립 시스템 API를 문서화되지 않은 채 운영 중이라 표준 스펙이 필요하다.

입력 예시
포인트 적립/사용 API가 필요합니다. 구매 시 적립, 사용 시 차감, 잔액 조회, 적립 내역 조회 기능이 있어야 하고 회원별로 관리됩니다. 특별히 지정할 인증 방식은 없어요.

결과 요약
기본값(JWT Bearer 인증 등)이 적용된 REST API 엔드포인트 명세와 스키마, 적립/차감 로직의 Mock 응답, 정상·에러 케이스 테스트 시나리오가 담긴 문서를 받습니다.