OpenAPI YAML 소스 유효성 검증

API를 편집할 때 OpenAPI 의 YAML 소스 파일을 Swagger 사양에 맞춰 검증하는 방법.

이 태스크에 대한 정보

API 편집기에서 API를 구성할 때, [검증] > [사양으로 검증]을 클릭하여 OpenAPI YAML 소스 파일을 검증할 수 있습니다. Swagger 구문 분석기 유효성 검증 오류가 발견되면 클릭하여 개별 오류 및 YAML에서 오류가 발생하는 위치를 확인할 수 있는 오류 아이콘이 표시됩니다. 그런 다음 오류를 수정하고 변경 사항을 저장한 뒤, API 구성 과정 전반에 걸쳐 OpenAPI YAML 파일을 계속 검증할 수 있습니다.

참고:

OpenAPI 검증 결과, API의 스테이징 또는 배포를 중단시킬 수 있는 게이트웨이 또는 정책 오류가 발견되지 않았습니다. 이 유형의 유효성 검증은 API를 스테이징하거나 공개하려는 경우에만 발생합니다. 자세한 내용은 ‘API 스테이징’ 또는 ‘API 게시’를 참조하세요.
거버넌스 규칙 세트를 사용하여 API 문서를 검증할 수도 있습니다. 자세한 내용은 거버넌스 서비스를 사용하여 API 또는 제품 문서를 검증하기를 참조하세요.

API Designer UI 애플리케이션을 사용하거나 브라우저 기반 API Manager UI를 사용하여 이 태스크를 완료할 수 있습니다.

프로시저

OpenAPI YAML 소스를 유효성 검증하려면 다음 단계를 완료하십시오.

OpenAPI 2.0 API 정의 편집 또는 OpenAPI 3.0 API 정의 편집에 설명된 대로 편집을 위해 필요한 API를 여십시오.
헤더의 메뉴 모음에서 ‘검증’ > ‘사양 적용’을 클릭합니다.
Swagger 구문 분석기 유효성 검증 오류가 발견되면 헤더 메뉴 표시줄에 오류 아이콘이 표시되고 발견된 OpenAPI 오류 수가 아이콘 옆에 표시됩니다.
예를 들어, 입니다.
그런 다음 오류 아이콘을 클릭하여 오류의 자세한 목록 및 YAML에서의 해당 위치를 볼 수 있습니다. ‘양식’ 보기에 있는 경우, 개별 오류를 클릭하면 양식 내의 해당 API 섹션으로 바로 이동할 수 있습니다.
오류를 수정한 후 저장 을 클릭하여 업데이트를 저장하고 유효성 검증 을 다시 클릭하십시오.
모든 오류가 수정되면 유효성 검증에서 성공 메시지를 리턴합니다.
예를 들어, 입니다.