API 사양 관리

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

이 문서에서는 API 허브에서 API 사양을 관리하는 방법을 설명합니다. API 사양 소개도 참조하세요.

버전에 API 사양 추가

API 버전에 하나 이상의 API 사양을 추가할 수 있습니다. 다음 옵션 중에서 선택합니다.

버전을 만들 때 사양 추가
기존 버전에 사양 추가

버전을 만들 때 사양 추가

UI만 사용하여 버전을 만드는 동시에 API 사양을 추가할 수 있습니다. 액세스할 수 있는 사양에 대한 URL을 제공하거나 시스템에서 직접 사양 파일을 업로드할 수 있습니다.

Console

새 버전에 사양을 추가하려면 다음 안내를 따르세요.

API 버전 만들기에 나열된 단계를 수행하여 시작합니다. 새 버전 추가 페이지에서 원하는 경우 버전에 사양 파일을 추가할 수 있습니다.
1. 사양 파일의 표시 이름을 입력합니다. 원하는 모든 이름을 사용할 수 있습니다.
2. 사양 파일 유형을 선택합니다. 사양 유형은 구성 가능한 시스템 속성입니다. 시스템 속성도 참조하세요.
3. 액세스할 수 있는 유효한 API 사양 파일을 가리키는 URI를 제공하거나 시스템에서 API 사양 파일을 찾아봅니다.
4. (선택사항) 업로드된 사양에 엄격한 검증을 적용하려면 오류가 포함된 사양 파일의 업로드 제한 체크박스를 선택합니다. 이 옵션을 선택하면 검증 오류가 포함된 사양이 업로드되지 않습니다. 기본적으로 오류가 포함된 사양이 업로드됩니다.
새 버전 추가 페이지를 작성하고 완료했으면 만들기를 클릭합니다.

기존 버전에 사양 추가

UI 또는 REST API를 사용하여 기존 버전에 API 사양을 추가할 수 있습니다.

Console

버전에 사양을 직접 추가하려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
수정하려는 버전이 있는 API를 찾습니다. 필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 선택합니다.
사양 파일 추가를 클릭합니다.
사양 파일의 표시 이름을 입력합니다. 원하는 모든 이름을 사용할 수 있습니다.
사양 파일 유형을 선택합니다. 사양 유형은 구성 가능한 시스템 속성입니다. 시스템 속성도 참조하세요.
액세스할 수 있는 유효한 API 사양 파일을 가리키는 URI를 제공하거나 시스템에서 API 사양 파일을 찾아봅니다.
(선택사항) 업로드된 사양에 엄격한 검증을 적용하려면 오류가 포함된 사양 파일의 업로드 제한 체크박스를 선택합니다. 이 옵션을 선택하면 검증 오류가 포함된 사양이 업로드되지 않습니다. 기본적으로 오류가 포함된 사양은 업로드됩니다.
사양 파일을 추가할 버전을 선택합니다.
만들기를 클릭합니다.
참고: 공개 프리뷰 출시의 경우 API 사양 파싱은 JSON 및 YAML 형식의 OpenAPI 사양(v.2.0, v3.0, v3.1)에서만 지원됩니다.

REST

버전에 API 사양을 추가하려면 API 사양 추가 API를 사용합니다.

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/API_PROJECT/locations/API_LOCATION/apis/API_ID/versions/VERSION_ID/specs?spec_id=SPEC_ID' \
  -d "DATA_FILE or URI"

다음을 바꿉니다.

API_PROJECT: API 허브 호스트 프로젝트의 이름. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_LOCATION: 호스트 프로젝트의 위치. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_ID: API 리소스의 고유 ID입니다.
VERSION_ID: API 리소스에 연결된 버전의 ID입니다.
SPEC_ID: (선택사항) 사양의 식별자입니다. 입력하지 않으면 시스템에서 생성된 ID가 사용됩니다. 이름은 4~63자(영문 기준)의 문자열이어야 하며 유효한 문자는 /[a-z][0-9]-/.입니다.
DATA_FILE or URI: 유효한 API 사양이 포함된 Base64로 인코딩된 파일 또는 사양 링크입니다. REST 예시를 참조하세요.

REST 예시

이 예시에서는 API 허브에 Base64로 인코딩된 OpenAPI 사양을 사용하여 새로운 사양을 만듭니다. 업로드 시 API 허브는 사양을 파싱하고 설명적인 메타데이터와 작업 및 정의 항목 집합을 포함하는 새로운 사양 항목을 만듭니다.

curl -X POST \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d "@data.json" \
  https://apihub.googleapis.com/v1/projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1/specs?spec_id=dstreetcarts-spec

샘플 출력:

{
    "name": "projects/common-dev-1/locations/us-central1/apis/streetcarts/versions/streetcartsv1/specs/dstreetcarts-spec",
    "displayName": "Test Spec 1",
    "specType": {},
    "contents": {
      "contents": [Base64-encoded contents of an OpenAPI 3.0.2 file] },
    "details": {
      "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification.\nYou can find out more about Swagger at [https://swagger.io](https://swagger.io).",
      "openApiSpecDetails": {
        "format": "OPEN_API_SPEC_3_0",
        "version": "1.0.11"
      }
    },
    "createTime": "2024-04-04T22:39:05.674986Z",
    "updateTime": "2024-04-04T22:39:05.674986Z"
  }

사양 세부정보를 반환하려면 다음 안내를 따르세요.

curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  https://apihub.googleapis.com/v1/projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1

출력:

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1",
  "displayName": "Test Version 3",
  "documentation": {},
  "specs": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1/specs/dstreetcarts-spec"
  ],
  "apiOperations": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1/operations/listpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1/operations/createpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1/operations/deletepet",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1/operations/getpetbyid",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1/operations/updatepet"
  ],
  "definitions": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1/definitions/pet"
  ],
  "createTime": "2024-04-04T14:53:57.299213423Z",
  "updateTime": "2024-04-04T14:53:58.027321138Z"
}

사양 나열

이 섹션에서는 API 버전과 관련된 사양을 나열하는 방법을 설명합니다.

Console

UI의 사양을 나열하는 방법은 다음과 같습니다.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
버전 탭에서 검사할 버전을 찾습니다.
버전을 선택합니다.
버전에 연결된 모든 사양은 사양 파일 섹션에 나열됩니다.

REST

API 버전과 연결된 사양을 나열하려면 사양 나열 API를 사용합니다.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/specs"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름입니다. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치입니다. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_ID: API 리소스의 고유 ID입니다.
VERSION_ID: 버전의 고유 ID입니다.

사양 세부정보 가져오기

이 섹션에서는 버전과 연결된 API 사양에 대한 세부정보를 가져오는 방법을 설명합니다.

Console

UI를 사용하여 사양 세부정보를 보려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
검사할 사양이 포함된 버전이 있는 API를 찾습니다. 필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
버전 탭에서 검사할 버전을 찾습니다.
버전을 선택합니다.
사양 파일 섹션에서 세부정보를 확인할 사양을 선택합니다.

REST

사양 세부정보를 보려면 사양 세부정보 가져오기 API를 사용합니다.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/specs/SPEC_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_ID: API 리소스의 고유 ID
VERSION_ID: 버전의 고유 ID입니다.
SPEC_ID: 사양의 고유 ID입니다.

샘플 출력:

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcartsv1/specs/dstreetcarts-spec",
  "displayName": "Test Spec 1",
  "details": {
    "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification.\nYou can find out more about Swagger at [https://swagger.io](https://swagger.io).",
    "openApiSpecDetails": {
      "format": "OPEN_API_SPEC_3_0",
      "version": "1.0.11"
    }
  },
  "createTime": "2024-04-04T22:39:05.098508600Z",
  "updateTime": "2024-04-04T22:39:06.661264958Z"
}

API 사양 삭제

이 섹션에서는 버전에서 API 사양을 삭제하는 방법을 설명합니다. 사양을 삭제하면 버전에서 연결된 작업도 삭제됩니다.

Console

UI로 API 리소스를 삭제하려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
삭제할 사양이 포함된 버전의 API를 찾습니다. 필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
버전 탭에서 삭제할 사양이 포함된 버전을 찾습니다.
버전을 선택합니다.
사양 파일 섹션의 삭제할 사양 행에 있는 작업 메뉴에서 삭제를 선택합니다.
삭제를 클릭합니다.

REST

API 허브에서 API 리소스를 삭제하려면 API 리소스 삭제 API를 사용합니다.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/specs/SPEC_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름입니다. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치입니다. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_ID: API 리소스의 고유 ID입니다.
VERSION_ID: 버전의 고유 ID입니다.
SPEC_ID: 삭제할 사양의 고유 ID입니다.

사양 메타데이터 수정

API 허브에 저장된 사양과 연결된 일부 메타데이터를 수정할 수 있습니다. 수정할 수 있는 메타데이터 목록은 사양 패치 API를 참고하세요.

콘솔

Google Cloud 콘솔을 통해 기존 사양을 변경할 수 있습니다. 예를 들어 표시 이름을 변경하고, 새 사양 파일을 업로드하고, 파일 형식을 변경하고, 속성을 수정할 수 있습니다.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
수정하려는 사양이 포함된 버전의 API를 찾습니다. 필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 봅니다.
버전 탭에서 수정하려는 사양이 포함된 버전을 찾습니다.
버전을 선택합니다.
버전 페이지에서 수정하려는 사양을 찾습니다.
수정하려는 사양 행의 작업 메뉴에서 수정을 선택합니다.
사양 수정 패널에서 다음 사양 메타데이터를 변경할 수 있습니다:
- 표시 이름
- 사양 파일 형식
- 사양 문서: 업로드할 새 사양 파일을 찾아봅니다.
- 사용자 정의 속성(있는 경우)
저장을 클릭합니다.

REST

REST API로 사양을 수정하려면 다음 안내를 따르세요.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/specs/SPEC_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
    '{
      "display-name": DISPLAY_NAME.  # Use the request body to specify attribute changes
      "contents": {
         "contents": Base64-encoded string
         "mimeType": MIME_TYPE
      }
    }'

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름입니다. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치입니다. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_ID: API 리소스의 고유 ID입니다.
VERSION_ID: 버전의 고유 ID입니다.
SPEC_ID: 사양의 고유 ID입니다.
요청 본문: 요청 본문을 사용하여 변경할 속성을 지정합니다. 사양 리소스 정의를 참조하세요.

사양 린트 결과 보기

API 허브는 API의 OpenAPI 사양의 유효성을 검사하는 기본 제공(스펙트럼) 린터(검사기)를 제공합니다. API 사양 유효성 검사를 참조하세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
검사할 사양이 포함된 버전의 API를 찾습니다. 필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
버전 탭에서 검사할 사양이 포함된 버전을 찾습니다.
린트 열에서 결과를 클릭하여 린트 결과를 봅니다.

사양 콘텐츠 가져오기

이 기능을 사용하면 API 허브에 업로드된 사양의 콘텐츠를 검토할 수 있습니다.

Console

UI를 사용하여 사양 세부정보를 보려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
삭제할 사양이 포함된 버전의 API를 찾습니다. 필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
버전 탭에서 검사할 사양이 포함된 버전을 찾습니다.
사양 이름을 클릭하여 콘텐츠를 확인합니다.

REST

API는 API 허브에 업로드된 API 사양의 Base64로 인코딩된 원시 콘텐츠를 검색합니다. 사양 콘텐츠 가져오기 API를 사용합니다.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID/specs/SPEC_ID:contents"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_ID: API 리소스의 고유 ID
VERSION_ID: 버전의 고유 ID입니다.
SPEC_ID: 사양의 고유 ID입니다.

샘플 출력:

{
  "contents": "Base64-encoded file contents"
}