모션드리븐 문서랩
API 문서화

API 레퍼런스 작성 워크숍

엔드포인트 설명, 오류 코드, 예시 페이로드를 한 흐름으로 묶는 API 문서화 집중 워크숍입니다.

OpenAPI 스펙을 읽는 법부터, 예시 응답의 신뢰도를 높이는 서술 방식까지 다룹니다. 보안에 민감한 필드는 마스킹 규칙을 함께 정리합니다.

  • 신규 엔드포인트 문서 초안을 48시간 내 제출 가능한 형태로 만듭니다.
  • 오류 상황을 사용자 언어로 설명하는 패턴을 익힙니다.

오프라인 워크숍 · 5일 집중

수강료 890,000 KRW (안내용 금액, 결제 기능 없음)

API 레퍼런스 작성 워크숍 대표 이미지

담당

최민아 사진
최민아

API 문서 전문 강사. 금융권 공개 API 문서 품질 개선 프로젝트를 다수 수행했습니다.

구성 요소

  • OpenAPI 기반 목차 설계
  • 오류 응답 표준 표
  • 샘플 코드 스니펫 가이드
  • 변경 이력 섹션 작성법
  • Postman 컬렉션과의 정합성 점검
  • 리뷰어를 위한 체크리스트

FAQ

OpenAPI 파일이 없어도 되나요?

없어도 됩니다. 대신 엔드포인트 목록과 샘플 로그를 준비해 주세요.

영문 문서도 다루나요?

본 워크숍은 한국어 설명 패턴에 초점을 맞춥니다. 영문 병행은 별도 모듈로 안내합니다.

워크숍에서 다루지 않는 범위는?

SDK 코드 생성이나 자동 배포 파이프라인 구축은 포함하지 않습니다.

후기

오류 코드 표를 처음부터 다시 짜 보니, 고객센터 티켓이 줄었습니다. 예시 JSON만 더 풍부하면 좋겠다는 피드백은 남았습니다.