Softonic

OpenAPI JSON 검증기

단계 1 / 2
다음

openapi.json 또는 swagger.json 파일의 내용을 붙여 넣으면 몇 초 만에 구조 검사 결과를 받을 수 있습니다. 이 검증기는 JSON이 파싱되는지, 버전 필드가 있는지, info에 title과 version이 있는지, paths가 존재하는지 확인한 뒤, 이상한 경로 이름이나 알 수 없는 작업 키에 대해 경고합니다.

OpenAPI JSON 파일을 검증하는 방법

  1. 1

    파일 복사

    `openapi.json`을 열고, 여는 중괄호부터 닫는 중괄호까지 문서 전체를 복사하세요.

  2. 2

    입력란에 붙여 넣기

    OpenAPI / Swagger 문서 입력란에 붙여 넣으세요. 공백을 제거하거나 다시 서식을 맞출 필요는 없습니다.

  3. 3

    검사 실행

    결과 단계로 넘어가 검증을 실행하세요.

  4. 4

    수정하고 반복

    오류마다 파일을 고친 뒤 다시 붙여 넣고, 보고서에 오류가 없을 때까지 다시 실행하세요.

검사가 실패하는 흔한 JSON 실수

JSON은 YAML보다 엄격하기 때문에, 손으로 편집한 파일이 실패하는 대부분의 원인은 API 설계가 아니라 문법입니다. 흔한 원인은 마지막 속성 뒤의 쉼표, 큰따옴표 대신 쓴 작은따옴표, 주석(JSON에서는 허용되지 않음), 긴 paths 객체 뒤에서 빠진 닫는 중괄호입니다. 깨진 파일은 보통 “Could not parse as JSON or YAML” 메시지로 끝나거나, 읽을 수 있는 내용이 없어서 필수 필드 오류가 나타납니다.

파싱 오류만 보인다면 먼저 문법 실수를 찾으세요. 구조 검사는 문서가 객체로 읽힌 뒤에 실행됩니다.

예제

다음의 작은 문서를 보세요.

{
  "openapi": "3.0.3",
  "info": { "title": "Orders API" },
  "paths": {
    "orders": { "get": { "summary": "List orders" } }
  }
}

이 문서는 파싱되며, openapi 필드와 paths 객체도 있습니다. 그래도 보고서에는 다음이 표시됩니다.

발견 사항 유형 이유
info.version is required. 오류 info에 title은 있지만 version이 없음
Path ‘orders’ should start with ‘/’. 경고 경로 키에 앞쪽 슬래시가 없음

오류가 하나 있으므로 이 문서는 유효하다고 보고되지 않습니다. info에 "version": "1.0.0"을 추가하고 키 이름을 /orders로 바꾸세요. 두 번째 실행에서 두 항목이 모두 사라집니다.

통과가 의미하는 것과 의미하지 않는 것

보고서가 깨끗하다는 것은 골격이 맞다는 뜻입니다. $ref 링크를 따라가지 않고, 스키마를 검사하지 않으며, 모든 작업에 응답이 있는지도 확인하지 않습니다. 파일을 커밋하기 전의 빠른 관문으로 사용하고, 더 깊은 규칙은 완전한 린터로 확인하세요.

JSON 명세를 위한 실용적인 워크플로

명세를 버전 관리에서 관리하고, paths를 건드리는 커밋을 하기 전에 이 도구에 붙여 넣으세요. 검사가 빠르기 때문에 여러 사람의 변경을 병합한 뒤 확인 단계로도 좋습니다. 중복된 키나 잘못 놓인 중괄호가 생기기 쉬운 순간이기 때문입니다. JSON이 빌드 스크립트로 생성된다면 템플릿이 아니라 생성된 결과를 붙여 넣으세요. 독자가 실제로 받게 될 내용을 테스트할 수 있습니다. 보고서가 깨끗하면, 최상위 구조가 건전하다는 확신을 가지고 파일을 공유하거나 문서 생성 도구에 넘길 수 있습니다.

자주 묻는 질문

아니요. 공백과 들여쓰기는 결과에 영향을 주지 않습니다. 파일을 있는 그대로 붙여 넣으세요.

표준 JSON은 객체나 배열의 마지막 항목 뒤에 쉼표를 허용하지 않으므로, 문서를 JSON으로 읽을 수 없습니다. 쉼표를 삭제하고 검사를 다시 실행하세요.

네. 버전 검사는 openapi 필드와 swagger 필드 중 어느 것이든 허용하므로, Swagger 2.0과 OpenAPI 3.x JSON 파일 모두 같은 구조 검사를 거칩니다.

아니요. 결과는 필드 누락이나 경로 이름 같은 메시지로 표시되며 줄 번호는 없습니다. 메시지에 적힌 키를 파일에서 검색하세요.

관련 도구

보색 찾기

어떤 입력에 대해서도 보색을 찾습니다. 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 코드로 확인하세요.

이 도구는 다른 언어로도 제공됩니다

사용 가이드와 활용 사례