이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.
이 주제에서는 API 허브에서 버전을 만들고 관리하는 방법에 대해 알아야 할 사항을 설명합니다.
버전이란?
API 허브의 모든 API 리소스에는 연결된 버전이 하나 이상 있습니다. 버전을 특정 시점의 API 상태로 생각하면 됩니다. 기본적으로 버전은 기본 작업, 배포, 기타 속성을 기반으로 API를 그룹화하고 구성하는 데 도움이 됩니다.
API 허브에서 버전은 API의 논리적 그룹을 나타냅니다. 일반적으로 이러한 그룹화는 API가 수행할 수 있는 작업을 중심으로 이루어집니다. 예를 들어 Pet Store API가 있고 이 API의 첫 번째 버전을 사용하면 반려동물 추가, 반려동물 찾기, 매장에서 반려동물 삭제와 같은 기본적인 작업을 수행할 수 있습니다. 다음은 작업의 예시입니다.
한 버전에 함께 배포되는 API 작업 집합을 포함하는 것이 좋습니다. 예를 들어 Pet Store API에는 추가, 찾기 및 삭제 작업이 모두 동일한 환경에 배포된 버전이 있을 수 있습니다.
버전에 대해 이해하는 또 다른 좋은 방법은 버전이 API에 대한 API 제작자의 관점을 나타낸다고 생각하면 됩니다. API는 API를 빌드한 사람들이 해당 API에 포함하여 함께 배포될 것으로 예상하는 특성과 기능의 모음입니다.
버전 생성
API 허브에 추가하려는 API의 세부정보가 OpenAPI 사양에 캡처되었다고 가정해 보겠습니다. 이 경우 API 버전에 사양을 추가할 수 있습니다. 이렇게 하면 API 허브가 사양을 파싱하고 API에 포함된 작업과 같은 정보를 가져와서 해당 정보를 버전에 저장합니다. OpenAPI 사양이 없어도 버전을 만들 수 있지만, 관련 설명 정보를 수동으로 입력해야 합니다. API 허브가 Apigee API 프록시 설정을 통해 API 세부정보 파싱을 지원하는 또 다른 경우입니다.
여러 API 사양 파일을 동일한 버전에 업로드할 수 있습니다.
언제 새 버전을 만들어야 하나요?
API에 새로운 작업이 추가되면 새 버전을 만들게 될 수도 있고 그렇지 않을 수도 있습니다.
API 제작자가 API에 새 작업을 추가하고 이를 현재 해당 버전과 연결된 모든 배포에 배포하려 한다고 가정해 보겠습니다. 이 경우 제작자는 API의 새 버전을 만들지 않도록 선택할 수 있습니다. 반면에 제작자가 이전 버전과 호환되지 않는 변경사항(브레이킹 체인지)을 수행하고 이를 새 배포와 연결하기로 선택한 경우 새 버전을 만드는 것이 좋습니다.
API 허브에서 조직의 필요와 특정 API 제작자의 요구사항에 맞게 API 버전을 정의하고 구성할 수 있는 유연성을 제공합니다.
시스템 속성
버전에는 기본적으로 다음 시스템 속성이 포함됩니다. 설정에서 이러한 속성과 연결된 값을 수정할 수 있습니다.
| 속성 | 설명 |
|---|---|
| API 수명 주기 단계 | 수명 주기는 API가 개념 구상부터 지원 종료까지 진행되는 단계의 순서가 지정된 단계 집합을 나타냅니다. 일반적으로 API의 각 버전은 자신의 수명 주기를 개별적으로 통과하므로, API의 수명 주기 단계를 직접 설정할 수는 없지만 각 API 버전에 수명 주기 단계를 할당할 수 있습니다. |
| 문서 | 버전이 연결된 API의 문서 링크. |
| 규정 준수 | 설정을 통해 팀 또는 조직에 필요한 규정 준수 세부정보를 나타내는 값을 정의할 수 있습니다. |
| 인증 | 설정을 통해 팀 또는 조직에 필요한 인증 세부정보를 나타내는 값을 정의할 수 있습니다. |
사용자 정의 속성
팀 또는 조직의 요구사항에 따라 버전의 커스텀 속성(이름/값 쌍)을 정의할 수 있습니다. 설정을 참조하세요.