OpenAPI YAML 검증기
openapi.yaml을 붙여 넣으면 모든 명세에 필요한 부분을 검사합니다. 버전 필드, title과 version이 있는 info 객체, paths 객체입니다. 또한 슬래시로 시작하지 않는 경로 키와 인식하지 못하는 작업 키에 대해 경고합니다.
OpenAPI YAML 파일을 검증하는 방법
-
1
YAML 복사
`openapi.yaml` 또는 `swagger.yaml`의 내용을 전부 복사하세요. 들여쓰기는 정확히 그대로 유지하세요.
-
2
입력란에 붙여 넣기
OpenAPI / Swagger 문서 입력란에 붙여 넣으세요. YAML에서는 들여쓰기가 곧 구조이므로 다시 입력하거나 줄을 재배치하지 마세요.
-
3
검증 실행
결과 단계로 넘어가 오류와 경고를 읽으세요.
-
4
수정하고 다시 검사
보고된 항목을 파일에서 고치고, 새 버전을 붙여 넣어 다시 실행하세요.
들여쓰기가 결과에 중요한 이유
YAML에서는 키의 중첩이 필드가 어느 객체에 속하는지를 결정합니다. version이 info 아래 한 단계 들여쓰기 되어야 하는데 같은 높이에 놓이면, 여전히 읽을 수 있는 YAML이지만 info.version은 없는 것으로 보고됩니다. paths도 마찬가지입니다. 경로 키가 실수로 info 아래로 들여쓰기 되면 최상위 paths 객체가 사라집니다.
들여쓰기에는 탭이 아니라 공백을 사용하고, 한 단계마다 두 칸처럼 일정한 간격을 유지하세요.
예제
openapi: 3.0.3
info:
title: Pets API
paths:
/pets:
get:
summary: List pets
버전 필드, info.title, paths가 모두 있고, /pets는 슬래시로 시작하며 get은 알려진 메서드입니다. 빠진 것은 하나뿐입니다. info.version입니다. 보고서에는 다음이 표시됩니다.
| 발견 사항 | 유형 |
|---|---|
| info.version is required. | 오류 |
info 아래에 두 칸 들여쓰기로 version: 1.0.0을 추가하면, 문서는 구조적으로 유효하다고 보고됩니다.
안정적인 읽기를 위해 문서를 단순하게 유지하기
이 검사는 일반적인 YAML 매핑, 즉 일정한 들여쓰기로 중첩된 단순한 key: value 줄을 가장 잘 읽습니다. 앵커나 여러 줄 블록 같은 고급 YAML 기능이 있는 문서가 읽을 수 없다고 나오거나 필드가 없다고 표시되면, 같은 명세의 JSON 사본을 시도해 보세요. 그러면 문제가 내용에 있는지 YAML 문법에 있는지 확인할 수 있습니다.
깨끗한 결과는 골격만 확인해 준다는 뜻입니다. $ref 링크를 해석하지 않으며 스키마도 검사하지 않습니다.
YAML 명세를 위한 실용적인 작업 흐름
작은 단계로 편집하고 그때마다 다시 검사하세요. 새 경로를 추가하거나 블록을 옮긴 뒤에는 파일을 다시 붙여 넣어, 잘못된 들여쓰기를 변경 사항이 아직 생생할 때 잡아내세요. 큰 명세를 여러 파일로 나누었다면, 결합한 버전을 붙여 넣으세요. 이 검사는 여러분이 준 텍스트만 읽고 다른 파일은 불러오지 않습니다. 렌더링된 페이지가 아니라 에디터에서 복사하세요. 웹 페이지는 공백과 따옴표를 모양이 비슷한 다른 문자로 바꿀 수 있고, 그러면 YAML을 읽는 방식이 달라질 수 있습니다.
마지막으로, 보고서는 검사가 볼 수 있는 것만 알려 준다는 점을 기억하세요. YAML 파일이 깨끗하다는 것은 최상위 골격이 맞다는 뜻이지, 그 안의 모든 작업, 스키마, 참조가 맞다는 뜻이 아닙니다.
자주 묻는 질문
공백입니다. YAML은 들여쓰기에 탭을 허용하지 않으며, 탭이 있으면 문서를 읽을 수 없게 되거나 필드가 잘못된 수준으로 이동할 수 있습니다.
보통 필드의 들여쓰기가 잘못된 수준에 있어서, 의도한 것과 다른 객체에 속하기 때문입니다. 필드의 들여쓰기를 상위 키와 비교해 보세요.
이 검사는 openapi 또는 swagger 필드가 있는지만 확인하고 값은 확인하지 않으므로, 따옴표가 있든 없든 모두 통과합니다. 그래도 Swagger에서는 "2.0"처럼 따옴표를 붙이는 습관이 좋습니다.
네. 텍스트는 먼저 JSON으로 읽히고, 실패하면 YAML로 읽히므로 같은 입력란에서 두 형식 모두 동작합니다.
관련 도구
보색 찾기
어떤 입력에 대해서도 보색을 찾습니다. HSL 반대 색, 분할 보색 쌍, 그리고 접근성 있는 조합 제안을 반환합니다.
Webpack 설정 생성기
순수 JavaScript, React, Vue용 webpack 5 webpack.config.js를 만드세요. TypeScript, Babel, CSS 또는 Sass, 이미지, HtmlWebpackPlugin, 개발 서버, npm install 명령까지 함께 제공합니다.
Protocol Buffers 디코더
hex, Base64, Base64URL, 텍스트 또는 파일의 Protobuf 와이어 형식 바이트를 브라우저에서 디코딩하고 정확한 필드 후보를 확인한 뒤 비공개 보고서로 내보냅니다.
XML 포매터
일관된 들여쓰기로 XML 문서를 정렬 출력하고, 정확한 줄 번호로 적격성 오류를 잡아냅니다.
XSD 검증기
XML 문서를 XSD 스키마에 대해 검증하고, 요소와 타입 불일치를 정확한 줄 번호와 함께 보고합니다.
색상 혼합기
두 HEX 색상을 2-20개의 균등한 색상 견본으로 섞습니다. 양 끝 색상을 포함해 각 중간 색상을 대문자 HEX 코드로 확인하세요.
이 도구는 다른 언어로도 제공됩니다
- ตัวตรวจสอบ OpenAPI YAML [TH]
- Walidator OpenAPI YAML [PL]
- Công cụ kiểm tra OpenAPI YAML [VI]
- Validator OpenAPI YAML [ID]
- مدقق OpenAPI بصيغة YAML [AR]
- OpenAPI YAML Validator [DE]
- OpenAPI YAML バリデーター [JA]
- Validador OpenAPI YAML [PT]
- Validador de OpenAPI YAML [ES]
- OpenAPI YAML-validerare [SV]
- Validateur OpenAPI YAML [FR]
- OpenAPI YAML Validator [NL]
- OpenAPI YAML Validator [EN]
- Validatore OpenAPI YAML [IT]
- Валидатор OpenAPI YAML [RU]
- OpenAPI YAML Doğrulayıcı [TR]
- OpenAPI YAML 验证器 [ZH]