Używanie metadanych na potrzeby ładu interfejsu API

Ten artykuł zawiera podstawowe informacje o metadanych i sposobie ich używania do zapewniania ładu interfejsu API w Centrum interfejsów API platformy Azure. Definiujesz i ustawiasz metadane w celu organizowania i filtrowania interfejsów API oraz innych jednostek w centrum interfejsu API. Metadane mogą być wbudowane lub niestandardowe i można opracować schemat metadanych w celu wymuszania spójności między interfejsami API, środowiskami i wdrożeniami.

Wbudowane metadane

Podczas tworzenia lub aktualizowania interfejsów API, środowisk i wdrożeń w centrum interfejsu API można ustawić pewne wbudowane właściwości metadanych, takie jak typ interfejsu API (REST, WSDL itd.).

W poniższych tabelach wymieniono wbudowane metadane udostępniane dla jednostek centrum interfejsów API platformy Azure. Aby uzyskać szczegółowe informacje, zobacz dokumentację interfejsu API REST Centrum interfejsów API. Tabele nie zawierają standardowych właściwości platformy Azure, takich jak identyfikatory zasobów, tytuły wyświetlania ani opisy. Nie wszystkie właściwości są wymagane.

API-e

Metadane	Description	Przykładowe wartości
rodzaj	Rodzaj (typ) interfejsu API	REST, SOAP, GraphQL
etap cyklu życia	Etap cyklu projektowania interfejsu API	Projektowanie, programowanie
licencja	Informacje o licencji dla interfejsu API	Identyfikator SPDX, link do tekstu licencji
dokumentacja zewnętrzna	Witryna zewnętrznej dokumentacji interfejsu API	Adres URL wskazujący dokumentację
informacje kontaktowe	Punkty kontaktowe interfejsu API	Adres e-mail, nazwa, adres URL
warunki użytkowania usługi	Warunki użytkowania interfejsu API	Adres URL wskazujący warunki użytkowania usługi

Środowiska

Metadane	Description	Przykładowe wartości
rodzaj	Rodzaj (typ) środowiska	Produkcja, przemieszczanie, programowanie
serwer	Informacje o serwerze środowiska	Typ i adres URL wskazujący serwer środowiska
typ serwera	Typ serwera środowiska	Serwer USŁUGI API Management, serwer Kubernetes, serwer Apigee
dołączanie	Informacje o dołączaniu dla środowiska	Instrukcje i adres URL wskazujące portal deweloperów środowiska

Wdrożenia

Metadane	Description	Przykładowe wartości
serwer	Informacje o serwerze wdrożenia	Adres URL wskazujący serwer wdrażania
stan	Stan wdrożenia	Aktywne, nieaktywne

Metadane niestandardowe

Zdefiniuj niestandardowe metadane przy użyciu witryny Azure Portal, interfejsu API REST centrum interfejsu API platformy Azure lub interfejsu wiersza polecenia platformy Azure , aby ułatwić organizowanie i filtrowanie interfejsów API, środowisk i wdrożeń w centrum interfejsu API. Usługa Azure API Center obsługuje niestandardowe metadane następujących typów.

Typ	Description	Przykładowa nazwa
typ logiczny (boolowski)	Prawda lub fałsz	IsInternal
Liczba	Wartość liczbowa	YearOfCreation
ciąg	Wartość tekstowa	Repozytorium GitHub
macierz	Lista wartości	tagi
wybór wbudowany	Wbudowana lista opcji	Department
obiekt	Obiekt złożony składający się z wielu typów	Interfejs APIApprover

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.

Przypisywanie metadanych do jednostek

Właściwości niestandardowych metadanych można przypisać do interfejsów API, środowisk lub wdrożeń w centrum interfejsu API. Można na przykład zdefiniować i przypisać metadane działu do interfejsów API, aby po zarejestrowaniu interfejsu API lub dodaniu nowej wersji interfejsu API określono dział odpowiedzialny za interfejs API.

Jeśli przypisano do jednostki, metadane są opcjonalne lub wymagane. Na przykład może być wymagane ustawienie metadanych działu tylko dla interfejsów API, ale zezwól na opcjonalne metadane dla środowisk YearOfCreation .

Uwaga / Notatka

Definiowanie niestandardowych metadanych w dowolnym momencie i stosowanie ich do interfejsów API i innych jednostek w centrum interfejsu API.
Po zdefiniowaniu metadanych niestandardowych można zmienić przypisanie do jednostki, na przykład z wymaganej do opcjonalnej dla interfejsów API.
Można zmienić wartości metadanych, ale nie można usunąć ani zmienić typu niestandardowych metadanych, które są obecnie ustawione w interfejsach API, środowiskach i wdrożeniach. Usuń najpierw niestandardowe metadane z jednostek, a następnie możesz je usunąć lub zmienić.