OpenAPI 유효성 검사기
OpenAPI 3.0 및 3.1 스펙(YAML 또는 JSON)을 브라우저에서 즉시 검사. 필수 필드, 경로 구조, 오퍼레이션 응답을 확인하고 스펙 요약을 표시. 100% 클라이언트사이드.
사용 방법
- OpenAPI 스펙(YAML 또는 JSON)을 에디터에 붙여넣습니다.
- 검증을 클릭하거나 Ctrl+Enter를 누릅니다.
- 유효하면 API 제목, 버전, 경로 수, 오퍼레이션 수가 요약 패널에 표시됩니다.
- 유효하지 않으면 각 오류가 JSON 경로와 설명과 함께 나열됩니다.
OpenAPI 3.x 필수 필드
openapi— 버전 문자열 (예:“3.0.3”또는“3.1.0”)info.title— API 이름info.version— API 버전 (예:“1.0.0”)paths— 경로 항목 맵; 각 키는/로 시작해야 함
자주 발생하는 실수
- OpenAPI 3.x 대신 Swagger 2.x 형식(
swagger: “2.0”) 사용 —swagger를openapi: “3.0.3”으로 변경하고definitions를components/schemas로 업데이트하세요. - 오퍼레이션 내에
responses객체 없음 — 모든 오퍼레이션은 최소 하나의 응답을 선언해야 합니다. /로 시작하지 않는 경로 키 — 모든 경로는 절대 경로여야 합니다 (예:/users/{id}).- YAML 들여쓰기 오류 — 먼저 YAML 유효성 검사기로 구문 문제를 해결하세요.
FAQ
어떤 OpenAPI 버전을 지원하나요?
OpenAPI 3.0.x 및 3.1.x 스펙을 지원합니다. Swagger 2.x(OpenAPI 2.0) 문서는 버전 경고와 마이그레이션 팁이 표시됩니다.
YAML과 JSON을 모두 검사할 수 있나요?
네. YAML 또는 JSON을 붙여넣으면 도구가 형식을 자동으로 감지하고 파싱합니다.
유효성 검사기가 확인하는 내용은?
최상위 필수 필드(openapi, info, paths), info 객체 필드(title, version), 경로 형식(/ 로 시작해야 함), 각 오퍼레이션의 responses 객체 존재 여부를 확인합니다.
API 스펙이 서버로 전송되나요?
아니요. 모든 검사는 브라우저의 JavaScript로 실행되며 서버로 전송되는 데이터가 없습니다.
OpenAPI 3.x 문서의 필수 필드는 무엇인가요?
openapi(버전 문자열), info.title, info.version, paths가 필수입니다. servers, components, tags, externalDocs는 선택 사항입니다.