Softonic

OpenAPI 명세 검증기 온라인

단계 1 / 2
다음

위에 OpenAPI 또는 Swagger 명세를 붙여 넣으면 오류와 경고 목록을 받을 수 있습니다. 이 페이지는 각 메시지의 의미와 해결 방법을 설명하므로, 빨간 보고서에서 깨끗한 보고서까지 빠르게 도달할 수 있습니다. 오류는 문서를 유효하지 않게 만들고, 경고는 그렇지 않습니다.

명세를 확인하고 보고서에 따라 조치하는 방법

  1. 1

    명세 붙여 넣기

    문서를 JSON 또는 YAML 형식으로 입력란에 붙여 넣으세요.

  2. 2

    결과 열기

    결과 단계로 넘어가면 유효하다는 메시지 또는 오류 목록을 볼 수 있습니다.

  3. 3

    각 메시지와 대조하기

    아래 표에서 메시지를 찾고 원본 파일에서 수정하세요.

  4. 4

    다시 붙여 넣기

    오류가 남지 않을 때까지 다시 실행한 뒤, 어떤 경고를 고칠 가치가 있는지 판단하세요.

오류 메시지 읽기

메시지 의미 해결 방법
Could not parse as JSON or YAML. JSON과 YAML 어느 형식으로도 읽을 수 없음 문법을 고치세요. 불필요한 쉼표, 잘못된 들여쓰기, 닫히지 않은 중괄호를 확인하세요
Missing ‘openapi’ or ‘swagger’ version field. 최상위에 버전 키가 없음 openapi: 3.0.3 또는 swagger: "2.0"을 추가하세요
Missing ‘info’ object. info 섹션이 없음 title과 version을 포함한 info를 추가하세요
info.title is required. info에 title이 없음 info 아래에 title을 추가하세요
info.version is required. info에 version이 없음 info 아래에 version을 추가하세요(여러분 API의 버전)
Missing ‘paths’ object. paths 섹션이 없음 처음에는 비어 있어도 paths를 추가하세요

오류는 문서가 유효하다고 판정될지를 결정합니다. 모든 오류를 먼저 해결하세요.

경고 메시지 읽기

메시지 의미 해결 방법
Path ‘x’ should start with ‘/’. paths 아래 키가 슬래시로 시작하지 않음 이름을 /x로 바꾸세요
Unknown method ‘x’ on /path. 경로 아래 키가 알려진 목록에 없음 오타인지 확인하세요. 의도한 확장이나 trace라면 무시해도 됩니다

알려진 목록은 get, post, put, patch, delete, head, options, parameters, summary, description, servers입니다. x-로 시작하는 벤더 확장은 이 목록에 없으므로 경고로 표시됩니다.

온라인 검사로 알 수 없는 것

보고서는 구조만 다룹니다. $ref 링크를 따라가지 않고, 스키마 정의를 검사하지 않으며, 누락된 operationId 값도 표시하지 않습니다. 통과는 파일이 OpenAPI 문서의 형태를 갖추었다는 확인으로 생각하세요. 문서를 게시하거나 클라이언트 코드를 생성하기 전에는 완전한 린터를 사용하세요.

긴 보고서를 처리하는 요령

맨 위부터 시작하세요. 파싱 오류가 있으면 다른 결과는 믿을 수 없으므로 가장 먼저 고치세요. 다음은 최상위의 누락된 필드를 처리하세요. 추가하기 쉽기 때문입니다. 그 뒤에야 경로 경고를 보세요. 편집할 때마다 조각이 아니라 전체 파일을 다시 붙여 넣으세요. 검사는 info와 paths를 찾기 위해 전체 문서가 필요합니다. 오류가 없고 의도한 경고가 몇 개 남아 있는 보고서는 정상적이고 받아들일 수 있는 마지막 상태입니다.

자주 묻는 질문

오류는 문서가 유효하지 않다고 보고된다는 뜻입니다. 경고는 슬래시로 시작하지 않는 경로처럼 살펴볼 항목을 알려 주지만, 유효 결과를 바꾸지는 않습니다.

꼭 그렇지는 않습니다. 최상위 구조가 갖춰져 있다는 뜻일 뿐입니다. 스키마, 참조, 응답은 검사되지 않았습니다.

경로 아래의 키는 고정된 HTTP 메서드 목록과 일부 경로 항목 필드와 비교됩니다. x- 키는 이 목록에 없으므로 경고로 표시됩니다. 그대로 두어도 괜찮습니다.

아니요. 오류는 검사 순서를 따릅니다. 버전 필드가 먼저, 그다음 info, 마지막으로 paths입니다. 줄 번호는 없습니다.

관련 도구

보색 찾기

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

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

사용 가이드와 활용 사례