Samouczek: definiowanie metadanych niestandardowych

W tym samouczku zdefiniuj niestandardowe metadane, aby ułatwić organizowanie interfejsów API i innych informacji w centrum interfejsu API. Użyj niestandardowych i wbudowanych metadanych do wyszukiwania i filtrowania oraz do wymuszania standardów ładu w organizacji.

Aby uzyskać podstawowe informacje o metadanych w centrum interfejsu API platformy Azure, zobacz:

• Najważniejsze pojęcia
• Metadane ładu interfejsu API

Z tego samouczka dowiesz się, jak używać portalu do wykonywania następujących problemów:

• Definiowanie niestandardowych metadanych w centrum interfejsu API
• Wyświetlanie schematu metadanych

Wymagania wstępne

• Centrum interfejsu API w ramach subskrypcji platformy Azure. Jeśli jeszcze go nie utworzono, zobacz Szybki start: tworzenie centrum interfejsu API.

Definiowanie metadanych

W tym miejscu zdefiniujesz dwa niestandardowe przykłady metadanych: biznesowe i publiczne; jeśli wolisz, zdefiniuj inne metadane własne. Podczas dodawania lub aktualizowania interfejsów API i innych informacji w spisie ustawisz wartości dla niestandardowych i wszystkich typowych wbudowanych metadanych.

Ważne

Nie dołączaj żadnych poufnych, poufnych ani osobistych informacji w zdefiniowanych tytułach (nazwach) metadanych. Te tytuły są widoczne w dziennikach monitorowania używanych przez firmę Microsoft do ulepszania funkcjonalności usługi. Jednak inne szczegóły i wartości metadanych to chronione dane klienta.

1. W witrynie Azure Portal przejdź do centrum interfejsu API.

2. W menu po lewej stronie w obszarze Zasoby wybierz pozycję Metadane > i nowe metadane.

3. Na karcie Szczegóły wprowadź informacje o metadanych.

   1. W polu Tytuł wprowadź wiersz działalności.

   2. Opcjonalnie wprowadź opis.

   3. Wybierz typ Wstępnie zdefiniowane opcje i wprowadź opcje , takie jak Marketing, Finanse, IT, Sales itd. Opcjonalnie włącz opcję Zezwalaj na wybór wielu wartości. Wybierz Dalej.

   

4. Na karcie Przypisania wybierz pozycję Wymagane dla interfejsów API. Wybierz opcję Opcjonalne w obszarze Wdrożenia i środowiska. (Te jednostki zostaną dodane w kolejnych samouczkach). Wybierz pozycję Dalej.

   

5. Na karcie Przeglądanie + tworzenie przejrzyj ustawienia i wybierz pozycję Utwórz.

   Metadane są dodawane do listy na stronie Metadane .

6. Wybierz pozycję + Nowe metadane , aby dodać kolejny przykład.

7. Na karcie Szczegóły wprowadź informacje o metadanych.

   1. W polu Tytuł wprowadź wartość Publiczna.

   2. Wybierz typ wartość logiczna.

8. Na karcie Przypisania wybierz pozycję Wymagane dla interfejsów API. Wybierz pozycję Nie dotyczy wdrożeń i środowisk.

9. Na karcie Przeglądanie + tworzenie przejrzyj ustawienia i wybierz pozycję Utwórz.

   Metadane są dodawane do listy.

Wyświetlanie schematu metadanych

Możesz wyświetlić i pobrać schemat JSON metadanych zdefiniowanych w centrum interfejsu API. Schemat zawiera wbudowane i niestandardowe metadane.

1. W menu po lewej stronie w obszarze Zasoby wybierz pozycję Schemat metadanych Widok metadanych>.

2. Wybierz pozycję Wyświetl interfejsy API schematu > metadanych, aby wyświetlić schemat metadanych dla interfejsów API, który zawiera wbudowane i niestandardowe metadane. Możesz również wyświetlić schemat metadanych zdefiniowany dla wdrożeń i środowisk w centrum interfejsu API.

   

Następne kroki

W tym samouczku przedstawiono sposób używania portalu do wykonywania następujących problemów:

• Definiowanie niestandardowych metadanych w centrum interfejsu API
• Wyświetlanie schematu metadanych

Po przygotowaniu schematu metadanych dodaj interfejsy API do spisu w centrum interfejsu API.

Rejestrowanie interfejsów API w spisie interfejsów API