자습서: 사용자 지정 메타데이터 정의

이 자습서에서는 API 센터에서 API 및 기타 정보를 구성하는 데 도움이 되는 사용자 지정 메타데이터를 정의하는 방법을 설명합니다. 검색 및 필터링에 사용자 지정 및 기본 제공 메타데이터를 사용하고 조직에서 거버넌스 표준을 적용할 수 있습니다.

Azure API Center의 메타데이터에 대한 자세한 내용은 다음을 참조하세요.

이 자습서에서는 Azure Portal을 사용하여 다음을 수행하도록 하는 방법을 알아봅니다.

필수 조건

여기서는 두 가지 사용자 지정 메타데이터인 업종 및 공용을 정의합니다. 원하는 경우 다른 메타데이터를 정의할 수 있습니다. 인벤토리에 API 및 기타 정보를 추가하거나 업데이트할 때 사용자 지정 및 일반적인 기본 제공 메타데이터에 대한 값을 설정합니다.

중요합니다

사용자가 정의하는 메타데이터의 제목(이름)에 중요한, 기밀 또는 개인 정보를 포함하지 마세요. 이러한 타이틀은 Microsoft에서 서비스의 기능을 개선하는 데 사용하는 모니터링 로그에 표시됩니다. 그러나 다른 메타데이터 세부 정보 및 값은 보호된 고객 데이터입니다.

Azure Portal에 로그인한 다음, API 센터로 이동합니다.
사이드바 메뉴의 자산 아래에서 메타데이터>+ 새 메타데이터를 선택합니다.
세부 정보 탭에서 메타데이터에 대한 정보를 입력합니다.
1. 타이틀에는 사업 분야를 입력합니다.
2. 필요에 따라 설명을 입력합니다.
3. 미리 정의된 선택 유형을 선택하고 마케팅, 재무, IT, 영업 등과 같은 선택 항목을 입력합니다. 필요에 따라 여러 값을 선택할 수 있도록 설정합니다. 다음을 선택합니다.
지정 탭에서 API의 필수를 선택합니다. 배포 및 환경에 대한 선택 사항을 선택합니다. 이후 자습서에서 이러한 엔터티를 추가할 수 있습니다. 다음을 선택합니다.
검토 + 만들기 탭에서 설정을 검토하고 만들기를 선택합니다.

메타데이터는 메타데이터 페이지의 목록에 추가됩니다.
+ 새 메타데이터를 선택하여 다른 예제를 추가합니다.
세부 정보 탭에서 메타데이터에 대한 정보를 입력합니다.
1. 제목에는 공개용을 입력합니다.
2. Boolean을 선택하십시오.
지정 탭에서 API의 필수를 선택합니다. 배포 및 환경에 적용되지 않음 을 선택합니다.
검토 + 만들기 탭에서 설정을 검토하고 만들기를 선택합니다.

메타데이터가 목록에 추가됩니다.

API 센터에 정의된 메타데이터에 대한 JSON 스키마를 보고 다운로드할 수 있습니다. 스키마에는 기본 제공 및 사용자 지정 메타데이터가 포함됩니다.

왼쪽 메뉴의 자산 아래에서 메타데이터>보기 메타데이터 스키마를 선택합니다.
메타데이터 스키마>API 보기를 선택하여 기본 제공 및 사용자 지정 메타데이터를 포함하는 API에 대한 메타데이터 스키마를 확인합니다. API 센터에서 배포 및 환경에 대해 정의된 메타데이터 스키마를 볼 수도 있습니다.

API 센터의 인벤토리에 API를 추가합니다.

이 페이지가 도움이 되었나요?