메인 콘텐츠로 건너뛰기

2026-05-18 · 1분 읽기

릴리스마다 OpenAPI 검증하기

깨진 계약을 일찍 잡으세요 — 누락된 paths, info 블록, 버전 drift.

OpenAPIAPICI

핵심 요점

  • 구조 검증은 response schema test 대체가 아닙니다 — 하지만 명백한 ship-stopper는 막습니다.
  • 서비스당 하나의 canonical spec 파일을 유지하고, publish하는 동일 artifact를 검증하세요.

CI에서 검증하는 이유

깨진 spec은 codegen, documentation portal, API gateway를 연쇄적으로 망가뜨립니다.

빠른 구조 검사는 paths 객체 누락이 production docs로 나갈 때 시간을 절약합니다.

워크플로

feature branch merge 후 JSON 또는 YAML을 OpenAPI Validator에 붙여넣으세요.

유효하면 같은 base URL과 auth로 HTTP Request로 critical paths를 spot-check하세요.

자주 묻는 질문

response examples도 검증하나요?

최상위 contract shape을 확인합니다; payload examples와 status code는 contract test를 추가하세요.

Swagger 2.0 지원?

기본 구조 검사가 적용됩니다; 가능하면 OpenAPI 3로 마이그레이션하세요.