API 문서기술 문서

엔드포인트 설명을 바탕으로 한 API 문서

납품 1일부터수정 포함품질 검수
패키지
안전 결제자세히
  • 패키지 범위 내 수정은 무료입니다.
  • 납품 후 3일 이내에 응답하지 않으면 작업이 자동으로 승인됩니다.
주문하기 · ₩56,300

결제 시 금액이 예치되며, 작업을 승인해야만 지급됩니다.

엔드포인트 설명을 바탕으로 한 API 문서

결과물 예시

스탠다드 패키지 예시

업무 매뉴얼(SOP): 작은 카페의 오픈·마감 절차

SOP-02: 카페 마감

목적매장을 깨끗하고 안전하게, 다음 날 아침 근무가 바로 시작할 수 있게 정리
담당마감 바리스타, 시프트 리더가 최종 확인
시간오후 5시 30분 시작, 6시 문 잠금, 6시 45분까지 완료
준비물마감 체크리스트, 포스 열쇠, 청소 도구 바구니, 파란 행주

시작하기 전에

주의: 벽의 메인 전원은 절대 내리지 마세요. 냉장고와 경보기가 같은 분전반에 연결되어 있습니다.

절차

  1. 오후 5시 30분, 출입문 안내판을 '라스트 오더'로 바꿉니다. 이미 매장에 계신 손님은 6시까지 머무를 수 있습니다.
  2. 커피 머신을 헹굼 모드로 바꿉니다. 컵 버튼을 5초간 누릅니다. 확인: 화면에 'RINSE'가 깜박이고 두 그룹헤드에서 약 2분간 뜨거운 물이 나옵니다.
  3. 포터필터를 빼서 세척 태블릿 1개를 넣은 검은 통에 담급니다. 20분간 둡니다.
  4. 케이크와 샌드위치를 안쪽 냉장고로 옮깁니다. 오늘 개봉한 것에는 오늘 날짜와 '내일까지'를 적은 라벨을 붙입니다.
  5. 냉장고 온도를 기록지에 적습니다. 확인: 1 °C~5 °C 사이. 5 °C를 넘는 냉장고가 있으면 12번부터 먼저 합니다.
  6. 오후 6시, 출입문을 잠그고 안내판을 '영업 종료'로 바꿉니다.
  7. 포스를 마감합니다. MENU → '일 마감' → 'Z 리포트' 순서로 누릅니다. 확인: 오늘 매출 합계가 인쇄됩니다. 현금은 카운터에서 세지 말고 서랍째 사무실로 가져갑니다.

(8~14단계: 바닥, 쓰레기, 경보기, 인수인계 메모)

문제가 생기면

문제할 일
냉장고가 5 °C 초과음식을 다른 냉장고로 옮기고 시간과 온도를 적은 뒤 시프트 리더에게 메시지
Z 리포트가 인쇄되지 않음영수증 용지를 교체. 그래도 안 되면 화면의 합계를 적고 사진으로 남김
경보기가 설정되지 않음뒷문이 완전히 닫혔는지 확인. 열려 있으면 설정되지 않음

확인 서명

마감 바리스타: 이름, 시간. 시프트 리더: 이니셜.

최종 검토일: [날짜]. 커피 머신이나 포스를 교체하면 다시 검토할 것.

의뢰인: 카페 은방울(22석, 교대 근무 직원 7명) 자료: 사장님의 음성 메모, 손으로 쓴 체크리스트, 카운터·커피 머신·포스 화면 사진 9장 결과물: SOP 6종(약 1만 3,000자): 오픈, 마감, 현금 관리, 냉장고 온도 기록, 커피 머신 집중 세척, 고객 불만 응대. 아래는 마감 절차 발췌입니다.

고객과 모든 정보는 가상입니다.

서비스 소개

개발자는 몇 분 만에 문서로 API를 판단합니다. 인증이나 첫 요청이 작동하지 않으면 떠나 버립니다. 엔드포인트 설명, OpenAPI 파일 또는 코드 샘플을 바탕으로 API 레퍼런스와 가이드를 작성합니다. 인증, 기본 URL, 파라미터가 포함된 각 엔드포인트, 요청 및 응답 예시, 오류 코드, 요청 한도, 페이지네이션까지 담습니다. 빠른 시작 가이드는 몇 단계 만에 첫 호출을 성공하는 방법을 보여 줍니다.

포함 사항

  • 제공 내용코드 블록이 포함된 Markdown 형식의 API 문서로 드리며, ReadMe, GitBook, Docusaurus 또는 저장소에 바로 사용할 수 있습니다. 보내 주신 자료를 바탕으로 작성하며 API를 직접 호출하지는 않습니다.
  • 빠른 시작API 키 발급부터 첫 호출까지
  • 엔드포인트 레퍼런스파라미터, 타입, 예시
  • 오류와 한도코드, 의미, 재시도 안내
  • 코드 샘플cURL과 선택하신 언어 1가지
  • 일관된 용어스키마와 동일한 이름

진행 방식

  1. 1
    요청 사항엔드포인트와 예시를 붙여 넣거나 첨부해 주세요
  2. 2
    구성과 작성레퍼런스와 가이드를 작성합니다
  3. 3
    납품바로 게시할 수 있는 Markdown을 받으십니다

준비해 주실 내용

텍스트로 붙여 넣은 엔드포인트 설명이나 OpenAPI 또는 Postman 파일, 인증 정보, 요청 및 응답 예시, 오류 코드, API 사용자층을 알려 주세요.

다음 내용을 여쭤봅니다:

  • API는 어떤 기능을 하며, 누가 사용하나요?
  • 인증은 어떻게 이루어지나요?
  • cURL 외에 코드 샘플은 어떤 언어로 작성할까요?
  • 문서는 어디에 게시되나요?

패키지 비교

패키지베이직빠른 시작과 최대 5개 엔드포인트₩27,400스탠다드가이드를 포함한 최대 20개 엔드포인트₩56,300프리미엄최대 50개 엔드포인트, 전체 문서₩114,000
작업 기간1일3일5일
수정 횟수123
분량최대 2,000단어최대 6,000단어최대 14,000단어
엔드포인트 수최대 5개최대 20개최대 50개
코드 샘플 언어cURLcURL + 1cURL + 2
주문하기 베이직주문하기 스탠다드주문하기 프리미엄

안전 결제

주문할 때 결제하지만, 대금은 승인된 작업에 대해서만 지급됩니다.

  • 고정 가격결제 후에는 패키지 가격이 변경되지 않습니다.
  • 금액 예치결제 시 금액은 예치만 됩니다. 작업을 승인하면 서비스에 지급됩니다.
  • 납품 전 검수모든 결과물은 전달되기 전에 품질 검수를 거치며, 승인하기 전에 주문 페이지에서 확인할 수 있습니다.
  • 무료 수정패키지에서 허용하는 횟수만큼 요청 사항 범위 내에서 수정을 요청할 수 있습니다.
  • 3일 후 자동 승인납품 후 3일 이내에 작업을 승인하거나 수정을 요청하지 않으면 자동으로 승인됩니다. 납품 후 주문 채팅에 메시지를 남기면 주문은 대기 상태가 됩니다. 저희가 답변한 뒤 3일을 다시 시작할 수 있으며, 이 경우 채팅으로 알려 드립니다.
  • 재작업 또는 전액 환불결과물이 요청 사항과 맞지 않고 수정으로도 해결되지 않았거나, 작업이 작업 기간의 두 배를 넘겨 지연되면 주문 채팅에 알려 주세요. 작업을 다시 하거나 결제 금액을 전액 환불해 드립니다.
이용 방법 →

질문과 답변

OpenAPI 명세를 바탕으로 작업할 수 있나요?

네, YAML이나 JSON을 요청 사항에 붙여 넣어 주세요. 설명을 읽기 쉬운 레퍼런스 페이지로 바꾸고, 짚어 주신 빈 부분을 채웁니다.

예시도 테스트해 주시나요?

API를 직접 호출하지 않습니다. 예시는 보내 주신 요청 및 응답 샘플로 만들어지므로, 게시 전에 한 번 실행해 보세요.

SDK 문서도 작성해 주시나요?

네, 메서드 시그니처와 사용 예시를 보내 주시면 가능합니다. 각 SDK는 패키지 분량에 포함하여 계산합니다.

패키지
주문하기 · ₩56,300· 3일