OpenAPI 기반 스펙 작성 실습
엔드포인트 정의부터 예시 응답까지, 팀이 그대로 배포에 쓰는 스펙을 만듭니다.
수강료 189,000 KRW (안내용 금액, 결제 기능 없음)
설명
이 패키지는 실제 서비스의 일부 엔드포인트를 가져와 스키마를 정리하고, 오류 응답과 버전 정책까지 한 번에 다룹니다. 페어 리뷰로 문장 표현과 필드 설명의 일관성을 맞추며, 린트 규칙을 프로젝트에 붙이는 과정까지 포함합니다.
포함 기능
- 스키마 분할 전략과 네이밍 규칙
- 예시 값·nullable 처리 가이드
- 에러 코드 테이블 템플릿
- 리뷰 체크리스트와 자동 검증 소개
- 배포 전 문서 동기화 루틴
- 팀 내 합의 문서 1부 제공
기대 결과
- 배포 가능한 OpenAPI 초안을 완성합니다.
- 코드 생성 파이프라인과 맞는 스펙 구조를 이해합니다.
- 리뷰 코멘트를 반영하는 습관을 만듭니다.
FAQ
가능합니다. 민감 정보는 마스킹한 샘플로 대체해 주세요. 실제 키나 고객 데이터는 과제에 포함하지 않는 것이 안전합니다.
기본은 3.1이며, 3.0과의 차이는 별도 모듈로 짧게 정리합니다. 레거시 2.0만 있는 팀은 사전에 알려 주시면 보조 자료를 드립니다.
런타임 성능 튜닝이나 인프라 구성은 범위 밖입니다. 문서 구조, 표현, 협업 프로세스에 집중합니다.
수강생 메모
OpenAPI 기반 스펙 작성 실습에서 스키마 분할 전략이 가장 도움이 됐어요. 지금도 PR마다 같은 체크리스트를 붙입니다.
예시 응답 템플릿 덕분에 QA와 말이 맞았습니다. 다만 초반 주차는 과제량이 빡빡했습니다.