버전 관리

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

이 주제에서는 API 버전을 만들고 관리하는 방법을 설명합니다. 버전에 대한 자세한 내용은 버전 개요를 참조하세요.

API에 버전 추가

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

콘솔

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

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
버전을 지정할 API를 찾습니다. 필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 봅니다.
버전 탭에서 버전 추가를 클릭합니다.
새 버전 추가 양식에 버전 세부정보를 지정합니다. 표시 이름을 제공해야 합니다. 다른 속성은 선택사항입니다. 속성에 대한 자세한 내용은 속성 관리를 참조하세요.
- 이름: (필수) 표시 이름을 제공해야 합니다.
- 설명: 버전에 대한 설명을 추가합니다.
- 수명 주기: API의 수명 주기 단계를 선택합니다.
- 규정 준수: 규정 준수 속성을 선택합니다.
- 인증: 인증 속성을 선택합니다.
- 문서: API 문서의 URL을 입력합니다.
- 사양 파일 추가: 버전과 연결할 API 사양 파일을 가져옵니다. 버전에 API 사양 추가를 참조하세요.
- 배포 연결: API와 연결할 배포를 하나 이상 선택합니다.
- 사용자 정의 속성: 사용자 정의 속성은 조직 또는 팀 요구사항에 따라 정의하는 속성입니다. 사용자 속성을 참조하세요.
만들기를 클릭합니다.

REST

API 버전 만들기 API를 사용하여 새 버전을 추가하려면 다음 안내를 따르세요.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions?version_id=VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME,
    "description": "DESCRIPTION"               # description is an optional attribute
    }'

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_ID: 버전을 추가할 API 리소스의 고유 ID입니다.
VERSION_ID: (선택사항) API 버전의 고유 식별자입니다. 제공하지 않으면 시스템에서 생성된 ID가 사용됩니다. 이름은 4~63자(영문 기준)의 문자열이어야 하며 유효한 문자는 /[a-z][0-9]-/.입니다.
DISPLAY_NAME: (필수) 버전의 표시 이름입니다. 원하는 모든 이름을 사용할 수 있습니다.
DESCRIPTION: (선택사항) 설명, 소유자 이름, 문서 링크 등 버전을 설명하는 여러 선택적 속성을 추가할 수 있습니다. 이러한 선택적 속성은 버전 리소스 정의에 나열되고 설명되어 있습니다.

샘플 출력:

{
  "name": "projects/myproject/locations/myproject/apis/docs-api-1/versions/myversion1",
  "displayName": "My Version 1",
  "createTime": "2024-04-02T18:48:41.162360Z",
  "updateTime": "2024-04-02T18:48:41.162360Z"
}

API 버전 나열

이 섹션에서는 등록된 API와 연결된 버전을 나열하는 방법을 설명합니다.

콘솔

콘솔에서 등록된 API와 연결된 모든 버전을 보려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
검사하려는 API를 찾습니다. 필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 선택합니다.
버전은 API 세부정보 페이지의 버전 표에 나열되어 있습니다.

REST

등록된 API와 연결된 모든 버전을 보려면 API 버전 나열 API를 사용합니다.

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

다음을 바꿉니다.

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

샘플 출력:

{
  "versions": [
    {
      "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
      "displayName": "Streetcarts Test v1"
    }
  ]
}

API 버전 세부정보 확인

이 섹션에서는 속성, 작업, 배포, 사양 파일을 포함하여 API 버전에 대한 세부정보를 가져오는 방법을 설명합니다.

콘솔

콘솔에서 버전 세부정보를 보려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
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"
  -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

샘플 출력:

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

API 버전 삭제

이 섹션에서는 API 리소스와 연결된 API 버전을 삭제하는 방법을 설명합니다.

콘솔

UI에서 버전을 삭제하면 해당 버전과 관련된 모든 기본 사양(있는 경우)이 삭제됩니다.

버전을 삭제하려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
삭제할 버전이 포함된 API를 찾습니다. 필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 선택합니다.
버전 표에서 삭제할 버전을 찾습니다.
작업 메뉴(버전이 포함된 행의 오른쪽)에서 삭제를 클릭합니다.

REST

기본적으로 기본 사양이 모두 삭제된 경우에만 버전이 삭제할 수 있습니다. 한 번에 버전의 모든 사양을 삭제하려면 Delete REST API에서 force 쿼리 파라미터를 true로 설정합니다.

API 버전 삭제 API를 사용하여 버전을 삭제하려면 다음 안내를 따르세요.

curl -X DELETE -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'

다음을 바꿉니다.

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

버전 및 모든 기본 사양을 삭제하려면 force 쿼리 매개변수를 true로 설정합니다. 예를 들면 다음과 같습니다.

curl -X DELETE -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?force=true'

버전 수정

콘솔

버전을 수정하려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 선택합니다.
버전 표에서 수정할 버전을 찾습니다.
버전 행의 오른쪽에 있는 작업 메뉴에서 수정을 선택합니다. 버전 세부정보 페이지에서 버전 수정을 클릭하여 수정 기능에 액세스할 수도 있습니다. 세부정보 페이지로 이동하려면 버전 테이블의 버전을 클릭하면 됩니다.
수정 후 저장을 클릭하여 변경사항을 저장합니다. 수정 가능한 속성에 대한 설명은 REST API 참조의 버전 리소스 설명을 참조하세요.

REST

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

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID?updateMask=LIST_OF_ATTRIBUTES"
    -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
      "description": "DESCRIPTION"

    }'

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_ID: 수정할 버전이 있는 API의 고유 ID
VERSION_ID: 수정할 버전의 ID
DESCRIPTION: 요청 본문에 설명 등의 수정 가능한 다른 속성을 추가할 수 있습니다. 수정 가능한 속성은 Apigee 허브 API 참조에 나열됩니다. 패치 버전 API
LIST_OF_ATTRIBUTES: 정규화된 속성 이름을 쉼표로 구분한 목록. 예를 들면 ?updateMask="description"입니다.

샘플 출력:

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
  "displayName": "Streetcarts Test v1",
  "description": "This is a revision of the test version.",
  "documentation": {},
  "createTime": "2024-04-18T19:57:11.870761Z",
  "updateTime": "2024-04-18T20:23:42.465324Z"
}