적용 대상: 모든 API Management 계층
모든 API 소비자가 동일한 버전을 사용하는 것은 비현실적인 상황이 있습니다. 소비자가 최신 버전으로 업그레이드할 준비가 되면 간단하고 이해할 수 있는 접근 방식을 선호합니다. 이 자습서에서 설명한 것처럼 Azure API Management는 이러한 요구를 충족하기 위해 여러 API 버전 노출을 지원합니다.
팁
API 팀은 작업 영역에서 이 기능을 사용할 수 있습니다. 작업 영역은 API 및 자체 API 런타임 환경에 대한 격리된 관리 액세스를 제공합니다.
이 자습서에서는 다음을 하는 방법을 알아볼 수 있습니다.
- 기존 API에 새 버전 추가
- 버전 관리 체계 선택
- 제품에 버전 추가
- 개발자 포털에서 버전 보기
필수 조건
- Azure API Management 용어에 대해 알아봅니다.
- 빠른 시작 Azure API Management 인스턴스 만들기를 완료합니다.
- 첫 번째 API 가져오기 및 게시 자습서를 완료합니다.
새 버전 추가
- Azure Portal에서 API Management 인스턴스로 이동합니다.
- 왼쪽 메뉴의 API 섹션에서 API를 선택합니다.
- API 목록에서 Swagger Petstore - OpenAPI 3.0 을 찾습니다. Swagger Petstore - OpenAPI 3.0 옆에 있는 줄임표(...)를 선택한 다음 버전 추가를 선택합니다. 다음 섹션의 결과 창에 값을 추가합니다.
팁
새 API를 만들 때 버전을 사용하도록 설정할 수도 있습니다. API 추가 화면에서 API 버전 관리를 선택합니다.
버전 관리 체계 선택
API Management에서 호출자가 버전 관리 체계인 경로, 헤더 또는 쿼리 문자열을 선택하여 API 버전을 지정하는 방법을 선택합니다. 다음 예제에서 Path 는 버전 관리 체계로 사용됩니다.
새 API를 버전으로 만들기 창에서 다음 표의 값을 입력합니다. 그런 다음, 만들기를 선택하여 자체 버전을 만듭니다.
| 설정 | 값 | 설명 |
|---|---|---|
| 버전 식별자 | v1 | 버전의 체계 관련 표시기입니다. 경로의 경우 API URL 경로의 접미사입니다. |
| 버전 관리 체계 | 경로 | 호출자가 API 버전을 지정하는 방식입니다. 헤더 또는 쿼리 문자열을 선택하는 경우 헤더 또는 쿼리 문자열 매개 변수의 이름이라는 다른 값을 입력합니다. 사용 예제가 표시됩니다. |
| 전체 API 버전 이름 | swagger-petstore-openapi-3-0-v1 | API Management 인스턴스의 고유한 이름입니다. 버전은 실제로 API의 수정 버전을 기반으로 하는 새 API이므로 이 값은 새 API의 이름입니다. |
| 제품 | 무제한 (일부 서비스 계층에서 제공) | 필요에 따라 API 버전이 연결된 하나 이상의 제품입니다. API를 게시하려면 API를 제품과 연결해야 합니다. 나중에 제품에 버전을 추가할 수도 있습니다. |
버전을 만든 후에는 API 목록의 Swagger Petstore - OpenAPI 3.0 아래에 표시됩니다. 이제 원본 및v1의 두 API가 표시됩니다.
참고 항목
버전이 아닌 API에 버전을 추가하는 경우 원래 버전도 자동으로 만들어집니다. 이 버전은 기본 URL에 응답합니다. 원래 버전은 버전이 추가된 후에도 기존 호출자의 호출이 계속 작동하도록 합니다. 버전을 처음부터 사용하도록 설정하여 새 API를 작성하는 경우 초기 버전은 생성되지 않습니다.
버전 편집
버전을 추가한 후에는 원본과 별개인 API로 편집하고 구성할 수 있습니다. 한 버전에 대한 변경 내용은 다른 버전에 영향을 주지 않습니다(예: API 작업을 추가 또는 제거하거나 OpenAPI 사양을 편집하는 경우). 자세한 내용은 API 편집을 참조하세요.
제품에 버전 추가
호출자가 새 버전을 보려면 제품에 추가해야 합니다. 아직 제품에 버전을 추가하지 않은 경우 언제든지 추가할 수 있습니다.
제품에 버전을 추가하려면 다음을 수행합니다.
- Azure Portal에서 API Management 인스턴스로 이동합니다.
- 왼쪽 창의 API 아래에서 제품을 선택합니다.
- 제품을 선택한 다음 왼쪽 창에서 API 를 선택합니다.
- 을 선택하고을 추가합니다.
- API를 선택합니다.
- 선택을 클릭합니다.
버전 집합 사용
여러 버전을 만들 때 Azure Portal은 단일 논리적 API에 대한 버전 세트를 나타내는 버전 집합을 만듭니다. 여러 버전이 있는 API의 이름을 선택하면 포털에 해당 버전 집합이 표시됩니다. 버전 집합의 이름과 설명을 사용자 지정할 수 있습니다.
Azure CLI를 사용하여 버전 집합과 직접 상호 작용할 수 있습니다.
Azure Cloud Shell에서 Bash 환경을 사용합니다. 자세한 내용은 Azure Cloud Shell 시작을 참조하세요.
CLI 참조 명령을 로컬에서 실행하려면 Azure CLI를 설치합니다. Windows 또는 macOS에서 실행 중인 경우 Docker 컨테이너에서 Azure CLI를 실행하는 것이 좋습니다. 자세한 내용은 Docker 컨테이너에서 Azure CLI를 실행하는 방법을 참조하세요.
로컬 설치를 사용하는 경우 az login 명령을 사용하여 Azure CLI에 로그인합니다. 인증 프로세스를 완료하려면 터미널에 표시되는 단계를 수행합니다. 다른 로그인 옵션은 Azure CLI를 사용하여 Azure에 인증을 참조하세요.
메시지가 표시되면 처음 사용할 때 Azure CLI 확장을 설치합니다. 확장에 대한 자세한 내용은 Azure CLI로 확장 사용 및 관리를 참조하세요.
az version을 실행하여 설치된 버전과 종속 라이브러리를 찾습니다. 최신 버전으로 업그레이드하려면 az upgrade를 실행합니다.
모든 버전 집합을 보려면 az apim api versionset list 명령을 실행합니다.
az apim api versionset list --resource-group <resource-group-name> \
--service-name <API-Management-service-name> --output table
Azure Portal에서 버전 집합을 만들 때 목록의 이름 열에 표시되는 영숫자 이름이 할당됩니다. 다른 Azure CLI 명령에서 이 이름을 사용합니다.
버전 집합에 대한 세부 정보를 보려면 az apim api versionset show 명령을 실행합니다.
az apim api versionset show --resource-group <resource-group-name> \
--service-name <API-Management-service-name> --version-set-id <ID from the Name column>
버전 집합에 대한 자세한 내용은 Azure API Management의 버전을 참조하세요.
개발자 포털에서 버전 보기
개발자 포털을 사용하는 경우 API 버전을 볼 수 있습니다.
- 창 맨 위에 있는 개발자 포털 을 선택합니다.
- API를 선택한 다음 Swagger Petstore를 선택합니다.
- API 이름 옆에 여러 버전을 나열하는 드롭다운이 표시됩니다.
- v1을 선택합니다.
- 목록에서 첫 번째 작업의 요청 URL을 확인합니다. API URL 경로에 v1이 포함되어 있습니다.
다음 단계
다음 자습서로 이동합니다.