Używanie metadanych na potrzeby ładu interfejsu API
Ten artykuł zawiera podstawowe informacje na temat metadanych i sposobu 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 i opisy. Nie wszystkie właściwości są wymagane.
Interfejsy API
| Metadane | opis | Przykładowe wartości |
|---|---|---|
| kind | rodzaj (typ) interfejsu API | REST, SOAP, GraphQL |
| etap cyklu życia | etap cyklu projektowania interfejsu API | projektowanie, programowanie |
| license (licencja) | informacje o licencji dla interfejsu API | Identyfikator SPDX, link do tekstu licencji |
| dokumentacja zewnętrzna | witryna dla zewnętrznej dokumentacji interfejsu API | Adres URL wskazujący dokumentację |
| informacje kontaktowe | punkty kontaktowe dla interfejsu API | adres e-mail, nazwa, adres URL |
| warunki świadczenia usługi | warunki świadczenia usługi dla interfejsu API | Adres URL wskazujący warunki użytkowania usługi |
Środowiska
| Metadane | opis | Przykładowe wartości |
|---|---|---|
| kind | 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 |
| onboarding | informacje o dołączaniu dla środowiska | instrukcje i adres URL wskazujące portal deweloperów środowiska |
Wdrożenia
| Metadane | opis | 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.
| Type | Opis | Przykładowa nazwa |
|---|---|---|
| boolean | prawda lub fałsz | IsInternal |
| Liczba | wartość liczbowa | YearOfCreation |
| string | wartość tekstowa | Repozytorium GitHub |
| tablica | lista wartości | Tagi |
| wybór wbudowany | wbudowana lista wyborów | Dział |
| 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. Na przykład zdefiniuj i przypisz 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
- 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ć.
Używanie metadanych na potrzeby ładu
Użyj wbudowanych i niestandardowych metadanych, aby zorganizować interfejsy API, środowiska i wdrożenia w centrum interfejsu API. Na przykład:
Wymuszanie standardów ładu w organizacji przez wymaganie ustawienia określonych metadanych dla interfejsów API, środowisk i wdrożeń.
Wyszukiwanie i filtrowanie interfejsów API w centrum interfejsu API według wartości metadanych. Możesz filtrować bezpośrednio na stronie interfejsów API w witrynie Azure Portal lub użyć interfejsu API REST centrum interfejsu API platformy Azure lub interfejsu wiersza polecenia platformy Azure do wykonywania zapytań o interfejsy API na podstawie wartości określonych metadanych.
