본문으로 건너뛰기

OpenAPI 검증기

YAML 또는 JSON 형식의 OpenAPI 3.0, 3.1, 3.2 또는 Swagger 2.0 문서를 검사하고 엔드포인트와 스키마를 요약합니다. 필수 필드, 경로 템플릿과 경로 매개변수의 일치 여부, 매개변수 위치, 응답 코드, 중복 operation ID 및 모든 로컬 $ref를 검사하고 각 문제의 위치를 표시합니다.

초기화

자주 묻는 질문

검증기는 무엇을 확인하나요?

openapi 또는 swagger 버전, info.title 및 info.version, 경로가 슬래시로 시작하는지 여부, 경로의 모든 {parameter}에 일치하는 필수 경로 매개변수가 있는지와 그 반대의 경우, 매개변수 이름과 위치, 응답 상태 코드와 설명, 중복 매개변수, 중복 operationId 값, 모든 로컬 $ref가 문서 내 항목을 가리키는지 검사합니다.

사양 전체에 대해 JSON Schema 유효성 검사를 수행하나요?

아니요. 위의 구조 규칙을 검사해 직접 작성한 문서의 대부분의 실수를 찾아내지만, 모든 필드를 공식 메타 스키마와 대조하거나 스키마 내용을 검사하지는 않습니다.

요약에는 무엇이 표시되나요?

사양과 API 버전, 제목, 모든 엔드포인트의 메서드, 경로, operationId, 요약 및 응답 코드가 포함된 표, 그리고 components.schemas 아래 스키마 이름 또는 Swagger 2.0의 정의가 표시됩니다.

외부 참조도 따라가나요?

아니요. 다른 파일이나 URL에 대한 참조는 가져오거나 보고하지 않습니다. #으로 시작하는 참조만 붙여넣은 문서 안에서 확인합니다.

오류와 경고는 어떻게 다른가요?

오류는 사양 규칙을 위반하는 경우를 말합니다. 예를 들어 응답 설명이 없거나 경로 매개변수가 선언되지 않은 경우입니다. 경고는 허용되지만 대개 의도하지 않은 항목을 가리킵니다. 예를 들어 요청 본문이 있는 GET 작업이나 operationId가 전혀 없는 문서가 해당합니다.

OpenAPI 3.1에서는 필수 항목이 달라지나요?

예. OpenAPI 3.1 및 3.2에서는 작업에 responses 객체가 더 이상 필수가 아니며, 문서에는 paths 대신 webhooks 또는 components가 있을 수 있습니다. openapi 필드가 3.1 또는 3.2로 시작하면 검증기는 해당 규칙을 적용합니다.

OneClick Pro 소개

OneClick Pro은 일상 업무에 활용할 수 있는 150개 이상의 웹 도구를 무료로 모아 제공합니다. 이미지와 단위를 변환하고, 코드를 포맷하고 검증하고, 도메인과 SEO를 확인하고, 텍스트와 날짜, 숫자를 다룰 수 있습니다. 모든 도구는 가입이나 구독 없이 사용할 수 있으며, 입력한 내용은 결과를 계산하는 데만 사용되고 저장되지 않습니다. 한 번 쓰는 작업을 위한 빠른 도구 모음으로 활용하거나, 매일 자주 쓰는 도구를 북마크해 두세요.