API 거버넌스에 메타데이터 사용
이 문서에서는 메타데이터에 대한 백그라운드 지식과 이를 Azure API Center의 API 관리에 사용하는 방법을 제공합니다. API 센터에서 API 및 기타 엔티티를 구성하고 필터링하기 위해 메타데이터를 정의하고 설정합니다. 메타데이터는 기본 제공되거나 사용자 지정될 수 있으며 메타데이터 스키마를 개발하여 API, 환경 및 배포 전반에 걸쳐 일관성을 강화할 수 있습니다.
기본 제공 메타데이터
API 센터에서 API, 환경 및 배포를 만들거나 업데이트할 때 API 유형(REST, WSDL 등)과 같은 특정 기본 제공 메타데이터 속성을 설정합니다.
다음 표에는 Azure API Center 엔터티에 대해 제공되는 기본 제공 메타데이터가 나열되어 있습니다. 자세한 내용은 API Center REST API 참조를 확인합니다. 테이블에는 리소스 식별자, 표시 제목, 설명과 같은 표준 Azure 속성이 포함되지 않습니다. 모든 속성이 필요한 것은 아닙니다.
API
| 메타데이터 | 설명 | 예제 값 |
|---|---|---|
| kind | API 종류(형식) | REST, SOAP, GraphQL |
| 수명 주기 단계 | API 개발 수명 주기 단계 | 디자인 및 개발 |
| license | API에 대한 라이선스 정보 | SPDX 식별자, 라이선스 텍스트 링크 |
| 외부 문서 | API에 대한 외부 설명서 사이트 | 설명서를 가리키는 URL |
| 연락처 정보 | API 연결 지점 | 이메일 주소, 이름, URL |
| 서비스 약관 | API 서비스 약관 | 서비스 약관을 가리키는 URL |
환경
| 메타데이터 | 설명 | 예제 값 |
|---|---|---|
| kind | 환경 종류(형식) | 프로덕션, 준비, 개발 |
| server | 환경의 서버 정보 | 환경 서버를 가리키는 형식 및 URL |
| 서버 유형 | 환경 서버 형식 | API Management 서버, Kubernetes 서버, Apigee 서버 |
| 온보딩 | 환경에 대한 온보딩 정보 | 환경의 개발자 포털을 가리키는 지침 및 URL |
배포
| 메타데이터 | 설명 | 예제 값 |
|---|---|---|
| server | 배포의 서버 정보 | 배포 서버를 가리키는 URL |
| state | 배포 상태 | 활성, 비활성 |
사용자 지정 메타데이터
Azure Portal, Azure API Center REST API 또는 Azure CLI를 사용하여 사용자 지정 메타데이터를 정의하면 API 센터에서 API, 환경 및 배포를 구성하고 필터링하는 데 도움이 됩니다. Azure API Center는 다음 형식의 사용자 지정 메타데이터를 지원합니다.
| Type | 설명 | 예제 이름 |
|---|---|---|
| 부울 값 | true 또는 false | IsInternal |
| 번호 | 숫자 값 | YearOfCreation |
| string | 텍스트 값 | GitHubRepository |
| 배열 | 값 목록 | 태그 |
| 기본 제공된 선택 | 기본 제공된 선택 목록 | 부서 |
| 개체 | 여러 형식으로 구성된 복합 개체 | APIApprover |
Important
정의하는 메타데이터의 제목(이름)에 중요한 정보, 기밀 정보 또는 개인 정보를 포함하지 마세요. 이러한 타이틀은 Microsoft에서 서비스의 기능을 개선하는 데 사용하는 모니터링 로그에 표시됩니다. 그러나 기타 메타데이터 세부 정보 및 값은 보호되는 고객 데이터입니다.
엔터티에 메타데이터 할당
사용자 지정 메타데이터 속성은 API 센터의 API, 환경 또는 배포에 할당될 수 있습니다. 예를 들어, Department 메타데이터를 API에 정의하고 할당하면 API가 등록되거나 새 API 버전이 추가될 때 API를 담당하는 부서가 할당됩니다.
엔터티에 할당된 경우 메타데이터는 선택 사항이거나 필수입니다. 예를 들어, Department 메타데이터는 API에 대해서만 설정되도록 요구하지만 YearOfCreation은 환경에 대한 선택적 메타데이터가 되도록 허용할 수 있습니다.
참고 항목
- 언제든지 사용자 지정 메타데이터를 정의하고 API 센터의 API 및 기타 엔터티에 적용합니다.
- 사용자 지정 메타데이터를 정의한 후 엔터티에 대한 할당을 변경할 수 있습니다(예: API의 경우 필수에서 선택 사항으로 변경).
- 메타데이터 값을 변경할 수 있지만 현재 API, 환경 및 배포에 설정된 사용자 지정 메타데이터 형식을 삭제하거나 변경할 수는 없습니다. 먼저 엔터티에서 사용자 지정 메타데이터를 할당 취소한 다음 이를 삭제하거나 변경할 수 있습니다.
거버넌스를 위해 메타데이터 사용
기본 제공 및 사용자 지정 메타데이터를 사용하여 API 센터에서 API, 환경 및 배포를 구성합니다. 예시:
API, 환경 및 배포에 대해 특정 메타데이터를 설정하도록 요구하여 조직에 거버넌스 표준을 적용합니다.
메타데이터 값을 기준으로 API 센터에서 API를 검색하고 필터링합니다. Azure Portal의 API 페이지에서 직접 필터링하거나 Azure API Center REST API 또는 Azure CLI를 사용하여 특정 메타데이터 값을 기반으로 API를 쿼리할 수 있습니다.
