Samouczek: definiowanie metadanych niestandardowych

Samouczek wyjaśnia, jak zdefiniować niestandardowe metadane, aby ułatwić organizowanie API i innych informacji w centrum API. Niestandardowe i wbudowane metadane umożliwiają wyszukiwanie i filtrowanie oraz wymuszanie standardów ładu w organizacji.

Aby uzyskać więcej informacji na temat metadanych w centrum interfejsu API platformy Azure, zobacz:

• Kluczowe pojęcia — metadane
• Używanie metadanych do zarządzania interfejsem API

Z tego samouczka dowiesz się, jak używać witryny Azure Portal do:

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

Wymagania wstępne

• Centrum API w subskrypcji Azure. Aby go utworzyć, zobacz Szybki start: tworzenie centrum interfejsu API.

Definiowanie metadanych

W tym miejscu zdefiniujesz dwa niestandardowe przykłady metadanych: linia biznesowa i publiczna; jeśli wolisz, zdefiniuj własne metadane. Podczas dodawania lub aktualizowania interfejsów API i innych informacji w inwentarzu należy ustawić 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. Zaloguj się do witryny Azure Portal, a następnie przejdź do centrum interfejsu API.

2. W menu paska bocznego w obszarze Zasoby wybierz pozycję Metadane>.

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

   1. W polu Tytuł wprowadź informację Linia biznesowa.

   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 Wymagane dla API. Wybierz opcję Opcjonalne w obszarze Wdrożenia i środowiska. Te jednostki można dodać w kolejnych samouczkach. Wybierz Dalej.

   

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

   Metadane są dodawane do listy na stronie Metadane .

6. Wybierz + Nowe metadane, by dodać kolejny przykład.

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

   1. W polu Tytuł wprowadź Przeznaczone do publicznego użytku.

   2. Wybierz typ Boolean.

8. Na karcie Przypisania wybierz Wymagane dla 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 Wyświetl schemat metadanych>interfejsy API, aby zobaczyć 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ępny krok

Dodaj interfejsy API do inwentarza w centrum API.

Rejestrowanie interfejsów API w spisie interfejsów API