API 사양 유효성 검사

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

미리보기 — Apigee API hub linting feature

이 기능에는 서비스별 약관의 일반 서비스 약관 섹션에 있는 'GA 이전 제공 서비스 약관'이 적용됩니다. GA 이전 기능은 '있는 그대로' 제공되며 지원이 제한될 수 있습니다. 자세한 내용은 출시 단계 설명을 참조하세요.

API 허브는 API의 OpenAPI 사양의 유효성을 검사하는 기본 제공 스펙트럼 린터(검사기)를 제공합니다. OpenAPI 사양을 API 버전에 추가하면 검사기(기본적으로 사용 설정됨)가 사양의 유효성을 검사하고 Google Cloud 콘솔에서 발견 항목을 보고합니다.

참고: 이 주제에서 linting 용어와 validating 용어는 같은 의미로 사용됩니다. 두 용어는 동일한 의미를 갖습니다.

사양 유효성 검사 사용 중지

기본적으로 린터는 사용 설정됩니다. 린터를 사용 중지하려면 Google Cloud 콘솔에서 API 허브 > 설정 > 작업 페이지로 이동한 후 린트 섹션에서 린트 작업 옵션을 사용 중지합니다.

스타일 가이드

스타일 가이드는 API 허브가 OpenAPI 사양의 유효성을 검사하는 규칙 집합입니다. API 허브는 OpenAPI 사양의 유효성을 검사하는 데 기본 스타일 가이드를 사용합니다. 기본 스타일 가이드 규칙은 OpenAPI 규칙을 참조하세요.

참고: 커스텀 규칙을 추가하려면 기본 스타일 가이드를 확장하는 새 스타일 가이드를 만들어야 합니다. 새 스타일 가이드에서 커스텀 규칙을 추가한 후에는 API 허브에 새 스타일 가이드를 업로드해야 합니다.

새 스타일 가이드 업로드

콘솔

새 스타일 가이드를 업로드하려면 다음 단계를 따르세요.

1. 기본 스타일 가이드를 확장하여 새 스타일을 만듭니다. 자세한 내용은 규칙 집합 만들기를 참조하세요.
   참고: 업로드에 대해 수행된 검증 단계에서 규칙 집합의 extends 속성에 URL이 표시되면 오류가 발생합니다. 예를 들어 다음은 잘못된 속성 생성으로서 업로드에 실패합니다. extends: [spectral:oas", "https://mystyle.com/"].

2. Google Cloud 콘솔에서 API 허브 > 설정 > 작업 페이지로 이동합니다.

3. 린트 작업 섹션에서 새 스타일 문서 업로드를 클릭합니다.
4. 1단계에서 만든 새 스타일 문서를 업로드한 다음 저장을 클릭합니다.

REST API

린트 작업을 위한 새 스타일 가이드를 업로드하려면 다음 API에 대해 PATCH 요청을 실행합니다.

https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/plugins/standard-linter/styleGuide?update_mask=contents

API에 대한 자세한 내용은 UpdateStyleGuide를 참조하세요.

참고: 업로드에 대해 수행된 검증 단계에서 규칙 집합의 extends 속성에 URL이 표시되면 오류가 발생합니다. 예를 들어 다음은 잘못된 속성 생성으로서 업로드에 실패합니다. extends: [spectral:oas", "https://mystyle.com/"].

다음 예시에서는 스타일 가이드를 업로드하기 위한 API 호출을 보여줍니다.

curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"name":"projects/test-project-1/locations/us-central1/plugins/standard-linter/styleGuide",
"contents":{  "contents": "ZXh0ZW5kczogWyJzcGVjdHJhbDpvYXMiXQo=",
  "mimeType": "text/yaml"}}' \ 
-X PATCH \
https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/plugins/standard-linter/styleGuide?update_mask=contents  

기본 스타일 가이드 다운로드

API 허브에서 린트 작업에 사용하는 기본 스타일 가이드를 다운로드하려면 다음 단계를 따르세요.

1. Google Cloud 콘솔에서 API 허브 > 설정 > 작업 페이지로 이동합니다.

2. 린트 작업 섹션에서 기본 스타일 문서 다운로드를 클릭합니다. 이렇게 하면 기본 스타일 문서가 로컬 시스템에 다운로드됩니다.

최신 스타일 가이드 다운로드

콘솔

API 허브에서 현재 린트 작업에 사용하는 스타일 가이드를 다운로드하려면 다음 단계를 따르세요.

1. Google Cloud 콘솔에서 API 허브 > 설정 > 작업 페이지로 이동합니다.

2. 린트 작업 섹션에서 최신 스타일 문서 다운로드를 클릭합니다. 이렇게 하면 기본 스타일 문서가 로컬 시스템에 다운로드됩니다.

REST API

현재 API 허브에서 린트 작업에 사용하는 스타일 가이드를 다운로드하려면 다음 API에 대해 GET 요청을 실행합니다.

https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/plugins/standard-linter/styleGuide:contents

API에 대한 자세한 내용은 GetStyleGuide를 참조하세요.

다음 예시에서는 현재 스타일 가이드를 다운로드하기 위한 API 호출을 보여줍니다.

curl -X \
GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/plugins/standard-linter/styleGuide:contents