빠른 시작: API 센터 만들기 - Azure CLI

아티클
06/27/2024

API 센터를 만들어 조직의 API 인벤토리를 시작합니다. Azure API Center를 사용하면 검색, 재사용 및 거버넌스를 위해 중앙 집중식 위치에서 API를 추적할 수 있습니다.

API 센터를 만든 후 자습서의 단계에 따라 사용자 지정 메타데이터, API, 버전, 정의 및 기타 정보를 추가합니다.

필수 조건

Azure를 구독하고 있지 않다면 시작하기 전에 Azure 체험 계정을 만듭니다.
Azure 구독에서 기여자 역할 할당 또는 해당 권한 이상

Azure CLI의 경우:
- Azure Cloud Shell에서 Bash 환경을 사용합니다. 자세한 내용은 Azure Cloud Shell의 Bash에 대한 빠른 시작을 참조하세요.
- CLI 참조 명령을 로컬에서 실행하려면 Azure CLI를 설치합니다. Windows 또는 macOS에서 실행 중인 경우 Docker 컨테이너에서 Azure CLI를 실행하는 것이 좋습니다. 자세한 내용은 Docker 컨테이너에서 Azure CLI를 실행하는 방법을 참조하세요.
  - 로컬 설치를 사용하는 경우 az login 명령을 사용하여 Azure CLI에 로그인합니다. 인증 프로세스를 완료하려면 터미널에 표시되는 단계를 수행합니다. 다른 로그인 옵션은 Azure CLI를 사용하여 로그인을 참조하세요.
  - 메시지가 표시되면 처음 사용할 때 Azure CLI 확장을 설치합니다. 확장에 대한 자세한 내용은 Azure CLI에서 확장 사용을 참조하세요.
  - az version을 실행하여 설치된 버전과 종속 라이브러리를 찾습니다. 최신 버전으로 업그레이드하려면 az upgrade를 실행합니다.
참고 항목

az apic 명령에는 apic-extension Azure CLI 확장이 필요합니다. az apic 명령을 사용하지 않은 경우 첫 번째 az apic 명령을 실행할 때 확장을 동적으로 설치하거나 확장을 수동으로 설치할 수 있습니다. Azure CLI 확장에 대해 자세히 알아보세요.

apic-extension의 최신 변경 내용 및 업데이트는 릴리스 정보를 참조하세요. 특정 기능에는 미리 보기 또는 특정 버전의 확장이 필요할 수 있습니다.

Microsoft.ApiCenter 공급자 등록

아직 등록하지 않았다면 구독에 Microsoft.ApiCenter 리소스 공급자를 등록해야 합니다. 리소스 공급자를 한 번만 등록하면 됩니다.

Azure CLI를 사용하여 구독에 리소스 공급자를 등록하려면 다음 az provider register 명령을 실행합니다.

az provider register --namespace Microsoft.ApiCenter

다음 az provider show 명령을 실행하여 등록 상태를 확인할 수 있습니다.

az provider show --namespace Microsoft.ApiCenter

리소스 그룹 만들기

모든 Azure 리소스와 마찬가지로 Azure API 센터 인스턴스는 리소스 그룹에 배포되어야 합니다. 리소스 그룹을 사용하면 관련 Azure 리소스를 구성하고 관리할 수 있습니다.

az group create 명령을 사용하여 리소스 그룹을 만듭니다. 다음 예에서는 미국 동부 위치에 MyGroup이라는 그룹을 만듭니다.

az group create --name MyGroup --location eastus

API 센터 만들기

az apic create 명령을 사용하여 API 센터를 만듭니다.

다음 예에서는 MyGroup 리소스 그룹에 MyApiCenter라는 API 센터를 만듭니다. 이 예에서 API 센터는 서유럽 위치에 배포됩니다. 원하는 API 센터 이름으로 대체하고 API 센터의 사용 가능한 위치 중 하나를 입력합니다.

az apic create --name MyApiCenter --resource-group MyGroup --location westeurope

명령의 출력은 다음과 유사합니다. 기본적으로 API 센터는 무료 계획으로 만들어집니다.

{
  "dataApiHostname": "myapicenter.data.westeurope.azure-apicenter.ms",
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mygroup/providers/Microsoft.ApiCenter/services/myapicenter",
  "location": "westeurope",
  "name": "myapicenter",
  "resourceGroup": "mygroup",
  "sku": {
    "name": "Free"
  },
  "systemData": {
    "createdAt": "2024-06-22T21:40:35.2541624Z",
    "lastModifiedAt": "2024-06-22T21:40:35.2541624Z"
  },
  "tags": {},
  "type": "Microsoft.ApiCenter/services"
}

배포 후에는 API 센터를 사용할 준비가 된 것입니다.

다음 단계

이제 API 센터의 인벤토리에 정보를 추가할 수 있습니다. API 및 기타 정보를 구성하는 데 도움이 되도록 API 센터에서 사용자 지정 메타데이터를 정의하는 것부터 시작합니다.

사용자 지정 메타데이터 정의

다음을 통해 공유