Centrum interfejsów API platformy Azure — kluczowe pojęcia
W tym artykule opisano kluczowe pojęcia centrum interfejsów API platformy Azure. Centrum interfejsów API platformy Azure umożliwia śledzenie interfejsów API w scentralizowanej lokalizacji na potrzeby odnajdywania, ponownego użycia i ładu.
Model danych
Na poniższym diagramie przedstawiono główne jednostki w centrum interfejsu API platformy Azure i sposób ich powiązania ze sobą. Więcej informacji na temat tych jednostek i powiązanych pojęć można znaleźć w poniższych sekcjach.
interfejs API
Jednostka logiczna najwyższego poziomu w centrum interfejsu API platformy Azure, interfejs API reprezentuje dowolny rzeczywisty interfejs API, który chcesz śledzić. Centrum interfejsów API może zawierać interfejsy API dowolnego typu, w tym REST, GraphQL, gRPC, SOAP, WebSocket i webhook.
Interfejs API w spisie może być zarządzany przez dowolne rozwiązanie do zarządzania interfejsami API, takie jak Azure API Management, Apigee API Management, Kong Konnect, MuleSoft API Management lub innej platformy. Interfejs API reprezentowany w centrum interfejsu API platformy Azure może być również niezarządzany.
Spis interfejsów API w Centrum interfejsu API platformy Azure został zaprojektowany do tworzenia i zarządzania nimi przez menedżerów programu interfejsu API lub administratorów IT. Centrum interfejsów API platformy Azure zawiera również funkcje dla deweloperów interfejsów API do rejestrowania definicji interfejsu API bezpośrednio ze środowisk deweloperskich, takich jak potoki ciągłej integracji/ciągłego wdrażania programu Visual Studio Code.
Wersja interfejsu API
Przechowywanie wersji interfejsu API to praktyka zarządzania zmianami w interfejsie API i zapewniania, że te zmiany są wprowadzane bez zakłócania działania klientów. Interfejs API może mieć wiele wersji na różnych etapach cyklu życia, z których każdy jest zgodny z określonymi zmianami interfejsu API. Niektóre wersje mogą wprowadzać istotne lub powodujące niezgodność zmiany, podczas gdy inne dodają drobne ulepszenia. Wersja interfejsu API może być na dowolnym etapie cyklu życia — od projektu, do wersji zapoznawczej, produkcyjnej lub przestarzałej.
Definicja interfejsu API
Każda wersja interfejsu API powinna być najlepiej zdefiniowana przez co najmniej jedną definicję, taką jak definicja interfejsu OpenAPI dla interfejsu API REST. Usługa Azure API Center umożliwia formatowanie dowolnego pliku definicji interfejsu API jako tekstu (YAML, JSON, Markdown itd.). Możesz między innymi przekazywać definicje OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL i WADL.
Aby ułatwić ład interfejsu API, centrum interfejsów API platformy Azure udostępnia funkcje lintingu umożliwiające analizowanie definicji interfejsu API pod kątem jakości i zgodności ze standardami organizacyjnymi.
Środowisko
Środowisko reprezentuje lokalizację, w której można wdrożyć środowisko uruchomieniowe interfejsu API, na przykład usługę Azure API Management, usługę APIGee API Management lub usługę obliczeniową, taką jak klaster Kubernetes, aplikacja internetowa lub funkcja platformy Azure. Każde środowisko jest dostosowane do etapu cyklu życia, takiego jak programowanie, testowanie, przemieszczanie lub produkcja. Środowisko może również zawierać informacje o portalu deweloperów lub interfejsach zarządzania.
Uwaga
Użyj centrum interfejsu API platformy Azure, aby śledzić dowolne środowiska uruchomieniowe interfejsu API, niezależnie od tego, czy są hostowane w infrastrukturze platformy Azure. Te środowiska nie są takie same jak środowiska wdrażania platformy Azure.
Wdrożenie
Wdrożenie to lokalizacja (adres), w której użytkownicy mogą uzyskiwać dostęp do interfejsu API. Interfejs API może mieć wiele wdrożeń, takich jak różne środowiska przejściowe lub regiony. Na przykład interfejs API może mieć jedno wdrożenie w wewnętrznym środowisku przejściowym, a drugi w środowisku produkcyjnym. Każde wdrożenie jest skojarzone z określoną definicją interfejsu API.
Metadane
W centrum interfejsów API platformy Azure organizuj interfejsy API, wdrożenia i inne jednostki, ustawiając wartości metadanych, które mogą służyć do wyszukiwania i filtrowania oraz wymuszania standardów ładu. Centrum interfejsu API udostępnia kilka typowych właściwości metadanych wbudowanych, takich jak "typ interfejsu API" i "etap cyklu życia". Właściciel centrum interfejsu API może rozszerzyć wbudowane metadane, definiując niestandardowe metadane w schemacie metadanych w celu organizowania ich interfejsów API, wdrożeń i środowisk. Na przykład utwórz właściwość osoby zatwierdzającej interfejsu API, aby zidentyfikować osobę odpowiedzialną za zatwierdzenie interfejsu API do użycia.
Usługa Azure API Center obsługuje niestandardowe metadane tablicy typów, wartości logicznej, liczby, obiektu, wstępnie zdefiniowanych wyborów i ciągu.
Schemat metadanych centrum interfejsu API platformy Azure jest zgodny ze specyfikacjami schematów JSON i YAML, aby umożliwić walidację schematu w narzędziach deweloperskich i zautomatyzowanych potokach.