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

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

Azure API 센터의 메타데이터에 대한 백그라운드 정보는 다음을 참조하세요.

• 주요 개념
• API 거버넌스용 메타데이터

이 자습서에서는 포털을 사용하여 다음을 수행하는 방법을 알아봅니다.

필수 조건

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

메타데이터 정의

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

1. Azure Portal에서 API 센터로 이동합니다.

2. 왼쪽 메뉴의 자산에서 메타데이터 > + 새 메타데이터를 선택합니다.

3. 세부 정보 탭에서 메타데이터에 대한 정보를 입력합니다.

   1. 타이틀에 기간 업무를 입력합니다.

   2. 필요에 따라 설명을 입력합니다.

   3. 미리 정의된 선택 항목 유형을 선택하고 마케팅, 재무, IT, 영업 등과 같은 선택 항목을 입력합니다. 필요에 따라 여러 값 선택 허용을 사용하도록 설정합니다. 다음을 선택합니다.

   

4. 할당 탭에서 API에 필수를 선택합니다. 배포 및 환경에 대해 선택 사항을 선택합니다. (이후 자습서에서는 이러한 엔터티를 추가합니다.) 다음을 선택합니다.

   

5. 검토 + 만들기 탭에서 설정을 검토하고 만들기를 선택합니다.

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

6. 다른 예를 추가하려면 + 새 메타데이터를 선택합니다.

7. 세부 정보 탭에서 메타데이터에 대한 정보를 입력합니다.

   1. 제목에 공용 지향을 입력합니다.

   2. 부울 유형을 선택합니다.

8. 할당 탭에서 API에 필수를 선택합니다. 배포 및 환경에 대해 적용할 수 없음을 선택합니다.

9. 검토 + 만들기 탭에서 설정을 검토하고 만들기를 선택합니다.

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

메타데이터 스키마 보기

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

1. 왼쪽 메뉴의 자산에서 메타데이터 > 메타데이터 스키마 보기를 선택합니다.

2. 기본 제공된 메타데이터와 사용자 지정 메타데이터가 포함된 API에 대한 메타데이터 스키마를 보려면 메타데이터 스키마 > API 보기를 선택합니다. API 센터에서 배포 및 환경에 대해 정의된 메타데이터 스키마를 볼 수도 있습니다.

   

다음 단계

이 자습서에서는 포털을 사용하여 다음을 수행하는 방법을 알아보았습니다.

이제 메타데이터 스키마를 준비했으므로 API 센터의 인벤토리에 API를 추가합니다.