다음을 통해 공유

Azure CLI를 사용하여 API 인벤토리 관리

  • 아티클

이 문서에서는 Azure CLI에서 az apic api 명령을 사용하여 API 센터 인벤토리에 API를 추가하고 구성하는 방법을 보여 줍니다. Azure CLI의 명령을 사용하여 API 인벤토리 및 API 센터의 기타 측면을 관리하는 작업을 스크립트합니다.

필수 조건

  • Azure 구독의 API 센터입니다. 아직 API 센터를 만들지 않았다면 빠른 시작: API 센터 만들기를 참조하세요.

  • Azure CLI의 경우:

    참고 항목

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

    apic-extension의 최신 변경 내용 및 업데이트는 릴리스 정보를 참조하세요.

API, API 버전, 정의 등록

다음 단계에서는 API를 만들고 단일 API 버전과 API 정의를 연결하는 방법을 보여 줍니다. Azure API 센터의 데이터 모델에 대한 백그라운드 정보는 주요 개념을 참조하세요.

API 만들기

API 센터에서 API를 만들려면 az apic api create 명령을 사용합니다.

다음 예에서는 myResourceGroup 리소스 그룹 및 myAPICenter API 센터에 Petstore API라는 API를 만듭니다. API는 REST API입니다.

az apic api create  --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API" --type "rest"

API 버전 만들기

API 버전을 만들려면 az apic api version create 명령을 사용합니다.

다음 예에서는 이전 섹션에서 만든 petstore-api API에 대해 v1-0-0이라는 API 버전을 만듭니다. 버전은 테스트 수명 주기 단계로 설정됩니다.

az apic api version create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --title "v1-0-0" --lifecycle-stage "testing"

API 정의 만들기 및 사양 파일 추가

API 버전에 대한 정의 및 관련 사양 파일을 추가하려면 az apic api 정의 명령을 사용합니다.

정의 만들기

다음 예에서는 az apic api definition create 명령을 사용하여 이전 섹션에서 만든 petstore-api API 버전에 대한 openapi라는 정의를 만듭니다.

az apic api definition create --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --version-id v1-0-0 --definition-id openapi --title "OpenAPI"

사양 파일 가져오기

az apic api definition import-specification 명령을 사용하여 사양 파일을 정의로 가져옵니다.

다음 예에서는 공개적으로 액세스 가능한 URL에서 이전 단계에서 만든 openapi 정의로 OpenAPI 사양 파일을 가져옵니다. 사양 리소스의 name 및 version 속성은 JSON으로 전달됩니다.

az apic api definition import-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --format "link" \
    --value 'https://petstore3.swagger.io/api/v3/openapi.json' \
    --specification '{"name":"openapi","version":"3.0.2"}'

팁

--format 매개 변수를 inline으로 설정하고 --value 매개 변수를 사용하여 파일 콘텐츠를 전달하여 사양 파일을 인라인으로 가져올 수 있습니다.

사양 파일 내보내기

API 사양을 API 센터에서 로컬 파일로 내보내려면 az apic api definition export-specification 명령을 사용합니다.

다음 예에서는 이전 섹션에서 만든 openapi 정의의 사양 파일을 specationFile.json이라는 로컬 파일로 내보냅니다.

az apic api definition export-specification \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api --version-id v1-0-0 \
    --definition-id openapi --file-name "/Path/to/specificationFile.json"

사양 파일에서 API 등록 - 단일 단계

az apic apiregister 명령을 사용하면 단일 단계로 로컬 사양 파일에서 API를 등록할 수 있습니다. 이 옵션을 사용하면 API에 대한 기본 API 버전 및 정의가 자동으로 만들어집니다.

다음 예에서는 specationFile.json이라는 로컬 OpenAPI 정의 파일에서 myAPICenter API 센터에 API를 등록합니다.

az apic api register --resource-group myResourceGroup \
    --service-name myAPICenter --api-location "/Path/to/specificationFile.json"
  • 이 명령은 정의 파일의 값에서 이름 및 형식과 같은 API 속성을 설정합니다.
  • 기본적으로 이 명령은 API의 수명 주기 단계를 디자인으로 설정합니다.
  • API 정의(또는 기본적으로 1-0-0 )의 version 속성에 따라 명명된 API 버전과 사양 형식(예: openapi)에 따라 명명된 API 정의를 만듭니다.

API 속성 업데이트

API를 등록한 후 az apic api update, az apic api version update 및 az apic api definition update 명령을 사용하여 API 속성을 업데이트할 수 있습니다.

다음 예제에서는 petstore-api API의 제목을 Petstore API v2로 업데이트합니다.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --title "Petstore API v2"

다음 예제에서는 API의 부울 내부 사용자 지정 속성을 false로 설정합니다.

az apic api update --resource-group myResourceGroup \
    --service-name myAPICenter --api-id petstore-api \
    --set custom_properties.internal=false

API 리소스 삭제

API와 해당 버전 및 정의 리소스를 모두 삭제하려면 az apic api delete 명령을 사용합니다. 예시:

az apic api delete \
    --resource-group myResourceGroup --service-name myAPICenter \
    --api-id petstore-api

개별 API 버전 및 정의를 삭제하려면 각각 az apic api version delete 및 az apic api definition delete를 사용합니다.

관련 콘텐츠