01
명세 버전부터 확인하기
루트 버전 필드에 따라 적용 규칙이 달라집니다. 3.1에서는 components만 있는 문서도 유효할 수 있으므로 엔드포인트가 없다고 항상 오류인 것은 아닙니다.
- 예제에는 재사용 매개변수와 재귀 모델이 포함되어 있습니다.
API 도구
OpenAPI 검증기API 계약을 살펴보세요
JSON 또는 YAML 명세를 붙여 넣고 작업별 매개변수와 진단을 확인한 뒤 필요한 결과를 내보내세요.
OpenAPI 검증기
OpenAPI 원문
결과
일치하는 요청 엔드포인트가 없습니다.
0개 중 0개 표시
명세는 이 브라우저 안에서 처리됩니다. API 요청이나 원격 참조 요청을 보내지 않습니다.
출력 옵션
문서 구조와 주요 경로 규칙을 검사합니다. 엔드포인트 내보내기는 paths만 포함하며 webhook과 callback은 제외합니다. 예제 값이나 실제 응답은 검사하지 않습니다.
입력 500,000자 · 깊이 60 · 노드 50,000개 · 진단 100개 · 검증 시간 5초 제한.
명세를 붙여 넣거나 예제를 불러오세요.
선택한 보기를 복사하거나 다운로드합니다. 엔드포인트 내보내기는 검색과 관계없이 전체 목록을 포함합니다.
OpenAPI 검증기는 자동 생성된 긴 계약을 검토할 때 유용합니다. JSON이나 YAML 문법이 맞아도 응답 설명이 빠지거나 경로 매개변수가 선언되지 않았을 수 있습니다. 원문과 작업 목록을 함께 보면 오류가 어디에 영향을 주는지 알 수 있습니다.
먼저 openapi 또는 swagger의 버전 값을 확인하세요. 정렬은 표현 형식을 바꾸고 검증은 문서 구조를 검사합니다. 실제 서버 응답이 계약을 지키는지는 별도 테스트가 필요합니다.
OpenAPI 검증기를 사용하는 이유
정의와 이를 사용하는 작업을 함께 확인하세요.
상속된 매개변수까지 한곳에서
OpenAPI 검증기는 요청 경로별로 작업을 묶어 보여 줍니다. 항목을 펼치면 상속된 매개변수, 요청 본문, 응답 코드, 서버와 보안 선언을 확인할 수 있습니다. 검색은 화면만 필터링하며 내보낸 목록은 전체를 유지합니다.
검사하지 못한 참조를 구분
같은 문서 안의 JSON Pointer를 찾아 대상이 없으면 오류로 표시합니다. 재귀 모델은 참조를 유지하여 끝없이 펼치지 않습니다. 외부 파일과 URL은 가져오지 않고 검사가 불완전하다는 경고를 남깁니다.
내보내기 전에 확인할 세 가지
02
실제로 적용되는 매개변수 읽기
작업에 경로 수준 매개변수와 같은 이름 및 위치의 항목이 있으면 해당 정의를 덮어씁니다. 합쳐진 결과에서 필수 여부와 스키마를 확인하세요.
- 자동 검증을 끄면 Ctrl/Cmd + Enter로 실행할 수 있습니다.
03
목적에 맞는 보기 선택하기
정렬된 명세는 편집용, 엔드포인트 보기는 전체 JSON 목록용, Markdown은 매개변수와 응답이 포함된 검토 문서용입니다.
- 원문이나 출력 옵션을 바꾸면 새 검증이 끝날 때까지 내보내기가 비활성화됩니다.
문서 구조에서 작업 상세까지
버전에 맞는 유효성 검사
OpenAPI 유효성 검사기는 Swagger 2.0과 OpenAPI 3.0/3.1의 실제 문서 스키마를 적용합니다. 3.1 모델 안의 표준 JSON Schema 2020-12 키워드 형태도 검사해 잘못된 타입 이름 등을 찾습니다.
경로와 작업의 일관성
중복 작업 ID, 같은 목록의 중복 매개변수, 선언되지 않았거나 필수가 아닌 경로 매개변수를 진단합니다. servers나 parameters 같은 메타데이터는 HTTP 작업 수에 포함하지 않습니다.
JSON과 YAML 사이 변환
공백 2칸 또는 4칸으로 정렬합니다. 값과 참조 문자열, 버전은 유지됩니다. Swagger 2.0의 definitions나 본문 매개변수를 OpenAPI 3 구조로 자동 이관하지 않습니다.
검토용 문서 생성
OpenAPI 문서의 API 정보, 서버, 작업별 매개변수, 요청 본문과 응답을 Markdown으로 정리합니다. 설명은 이스케이프하고 코드 블록은 안전하게 구분하며 화면에서 HTML을 실행하지 않습니다.
검사 범위와 입력 제한
- 단일 문서와 지원 버전
- Swagger 2.0, OpenAPI 3.0.x 및 3.1.x를 지원합니다. 3.2와 다른 명세 형식은 명시적으로 거부합니다. 로컬 참조는 이 문서 내부를 뜻하며 컴퓨터의 다른 파일을 읽는 기능이 아닙니다.
- 외부 참조와 고급 범위
- 원격 URL과 상대 파일 경로는 가져오지 않습니다. 리소스 ID, 앵커, 동적 참조, 사용자 방언은 불완전한 검사로 표시됩니다. 전체 의존성을 확인하려면 신뢰할 수 있는 환경에서 먼저 문서를 합치세요.
- YAML 표현은 다시 생성
- 주석과 따옴표 스타일은 유지되지 않습니다. 문자열 키를 쓰는 단일 YAML 1.2 문서를 사용하세요. 앵커, 별칭, 병합 키, 사용자 태그, 중복 키, 정밀도를 잃는 숫자는 거부합니다.
- 요청 엔드포인트만 목록화
- 목록은 paths 아래 작업을 포함합니다. Webhook과 callback은 구조만 검사하고 목록과 경로 의미 검사에서 제외합니다. 예제 값, 실제 응답, 인증 및 업무 규칙은 별도 테스트 대상입니다.
- 처리 한도 초과 시 중단
- 입력 500,000자, 깊이 60, 노드 50,000개까지 처리합니다. 진단 100개, 결과 2,000,000자 또는 검증 5초를 넘으면 중단합니다. 큰 계약은 나누어 검토하고 중단된 결과를 통과로 해석하지 마세요.
OpenAPI 검증기 자주 묻는 질문
어떤 OpenAPI 버전을 지원하나요?
Swagger 2.0과 OpenAPI 3.0.x 및 3.1.x를 지원합니다. 루트 필드로 버전을 정하며 3.2 등 지원하지 않는 버전에는 다른 규칙을 대신 적용하지 않습니다.
YAML과 JSON을 모두 검사할 수 있나요?
네. 입력과 출력 형식을 다르게 선택할 수 있습니다. YAML에서는 응답 코드 같은 매핑 키도 문자열이어야 합니다. 정렬한 결과에 주석이나 기존 따옴표 스타일이 남지는 않습니다.
유효성 검사기는 무엇을 확인하나요?
문서 스키마, 표준 스키마 키워드, 로컬 참조, 주요 경로 규칙을 확인합니다. 외부 대상과 고급 방언은 미검증으로 표시하며 실제 응답이나 예제 값은 검사하지 않습니다.
API 명세가 서버로 전송되나요?
아니요. 브라우저 worker에서 분석하고 검증하며 문서 안 URL에도 접근하지 않습니다. 페이지를 새로 고친 뒤 원문을 자동 복원하는 저장 기능은 없습니다.
OpenAPI 3.x 문서의 필수 필드는 무엇인가요?
openapi와 title, version이 들어 있는 info가 필요합니다. 3.0은 paths가 필요하지만 3.1은 paths, components 또는 webhooks를 사용해 내용을 정의할 수 있습니다.
예상과 다른 결과가 나왔나요?
다음 계약을 검토하세요
OpenAPI 검증기로 버전과 진단을 확인하고 동료에게 필요한 보기를 내보내세요.
정렬해도 명세의 원래 버전은 바뀌지 않습니다.