Azure API Center - 주요 개념
이 문서에서는 Azure API Center의 주요 개념을 설명합니다. Azure API Center를 사용하면 검색, 재사용 및 거버넌스를 위해 중앙 집중식 위치에서 API를 추적할 수 있습니다.
데이터 모델
다음 다이어그램은 Azure API Center의 주 엔터티와 이러한 엔터티가 서로 어떻게 관련되어 있는지 보여줍니다. 이러한 엔터티 및 관련 개념에 대한 자세한 내용은 다음 섹션을 참조하세요.
API
Azure API Center의 최상위 논리 엔터티인 API는 추적하려는 실제 API를 나타냅니다. API Center에는 REST, GraphQL, gRPC, SOAP, WebSocket 및 Webhook를 비롯한 모든 형식의 API를 포함할 수 있습니다.
인벤토리의 API는 Azure API Management, Apigee API Management, Kong Konnect, MuleSoft API Management 또는 다른 플랫폼과 같은 모든 API 관리 솔루션에서 관리할 수 있습니다. Azure API Center에 표시되는 API는 관리되지 않을 수도 있습니다.
Azure API Center의 API 인벤토리는 API 프로그램 관리자 또는 IT 관리자가 만들고 관리하도록 설계되었습니다.
API 버전
API 버전 관리는 API에 대한 변경 내용을 관리하고 클라이언트를 방해하지 않고 이러한 변경이 수행되도록 하는 방법입니다. API는 수명 주기 단계 전반에 걸쳐 여러 버전을 가질 수 있으며 각 버전은 특정 API 변경 사항에 맞춰 조정됩니다. 일부 버전에서는 주요 변경 내용 또는 호환성이 손상되는 변경 내용이 도입될 수 있지만 다른 버전에서는 사소한 개선 사항이 추가될 수 있습니다. API 버전은 설계부터 미리 보기, 생산 또는 사용 중단까지 모든 수명주기 단계에 있을 수 있습니다.
API 정의
각 API 버전은 REST API에 대한 OpenAPI 정의와 같은 하나 이상의 정의로 정의해야 합니다. Azure API Center에서는 텍스트로 서식이 지정된 모든 API 정의 파일(YAML, JSON, Markdown 등)을 허용합니다. OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL 및 WADL 정의 등을 업로드할 수 있습니다.
환경
환경은 API 런타임을 배포할 수 있는 위치(예: Azure API Management 서비스, Apigee API Management 서비스, Kubernetes 클러스터, 웹앱 또는 Azure 함수와 같은 컴퓨팅 서비스)를 나타냅니다. 각 환경은 개발, 테스트, 준비 또는 프로덕션과 같은 수명 주기 단계에 맞춰 조정됩니다. 환경에는 개발자 포털이나 관리 인터페이스에 대한 정보가 포함될 수도 있습니다.
참고 항목
Azure API Center를 사용하여 Azure 인프라에서 호스트되는지 여부에 관계없이 API 런타임 환경을 추적합니다. 이러한 환경은 Azure Deployment Environments와 동일하지 않습니다.
배포
배포는 사용자가 API에 액세스할 수 있는 위치(주소)입니다. API에는 다양한 스테이징 환경 또는 지역과 같은 여러 배포가 있을 수 있습니다. 예를 들어 API는 내부 스테이징 환경에 하나의 배포를, 프로덕션 환경에서는 두 번째 배포를 가질 수 있습니다. 각 배포는 특정 API 정의와 연결됩니다.
메타데이터
Azure API 센터에서는 검색 및 필터링에 사용할 수 있고 거버넌스 표준을 적용하는 데 사용할 수 있는 메타데이터 값을 설정하여 API, 배포 및 기타 엔터티를 구성합니다. API 센터는 "API 유형" 및 "수명 주기 단계"와 같은 몇 가지 일반적인 기본 제공 메타데이터 속성을 제공합니다. API 센터 소유자는 메타데이터 스키마에 사용자 지정 메타데이터를 정의하여 API, 배포 및 환경을 구성함으로써 기본 제공된 메타데이터를 강화할 수 있습니다. 예를 들어 API 승인자 속성을 만들어 사용할 API를 승인할 책임이 있는 개인을 식별합니다.
Azure API 센터는 배열, 부울, 숫자, 개체, 미리 정의된 선택 사항 및 문자열 형식의 사용자 지정 메타데이터를 지원합니다.
Azure API Center의 메타데이터 스키마는 JSON 및 YAML 스키마 사양과 호환되므로 개발자 도구 및 자동화된 파이프라인에서 스키마 유효성을 검사할 수 있습니다.