Importowanie i publikowanie interfejsu API

  • 5 min

Aby udostępnić interfejs API za pośrednictwem bramy interfejsów API, należy zaimportować i opublikować ten interfejs API.

W przykładzie firmy obuwniczej firma NorthWind Shoes chce umożliwić wybranym partnerom wysyłanie zapytań względem spisu towarów i poziomów zapasów.

Tutaj dowiesz się, jak zaimportować interfejs API do usługi Azure API Management i jak udostępnić interfejs API klientom.

interfejs API

Interfejs API to ustandaryzowany sposób, w jaki organizacje mogą uwidaczniać określone dane potencjalnym deweloperom lub partnerom. Na przykład w poprzednim ćwiczeniu utworzyliśmy interfejs API, aby udostępniać informacje o produktach i spisie towarów.

Udostępnianie interfejsu API rozpoczyna się od zaimportowania interfejsu API do usługi API Management. Następnie można wykonywać czynności takie jak:

  • Przetestuj interfejs API przy użyciu narzędzi do wizualizacji w bramie interfejsu API.
  • Zarządzanie dostępem do interfejsów API przy użyciu zasad.

Struktury interfejsów API

Istnieją różne struktury i standardy interfejsów API. Usługa API Management zapewnia kilka opcji importowania interfejsów API. W tym opcje w poniższej tabeli:

Typ Szczegóły
HTTP Interfejs API HTTP można zaimportować z pustą definicją interfejsu API. Następnie możesz ręcznie określić wymagane parametry.
WebSocket Skonfiguruj przekazywanie do usługi WebSocket zaplecza.
GraphQL Skonfiguruj przekazywanie do usługi GraphQL zaplecza lub zaimportuj schemat GraphQL i utwórz syntetyczny interfejs API GraphQL z niestandardowymi narzędziami rozpoznawania pól.
OpenAPI Interfejs OpenAPI to specyfikacja, która dokumentuje wszystkie punkty końcowe i operacje dla interfejsów API RESTful oraz wszystkie parametry wejściowe i wyjściowe. Interfejs OpenAPI pierwotnie był nazywany strukturą Swagger.
WADL Język Web Application Description Language to opis w formacie XML usług internetowych opartych na protokole HTTP. Jest to prostszy format i bardziej uproszczony niż język opisu usługi internetowej.
WSDL Język Web Service Description Language to opis w formacie XML dowolnej usługi sieciowej, nie tylko opartej na protokole HTTP.

Możesz również zaimportować interfejsy API z kilku zasobów zaplecza platformy Azure. Opcje obejmują te z poniższej tabeli.

Typ Szczegóły
Azure OpenAI Service Interfejsy API, które zapewniają dostęp do modeli językowych openAI dla zadań, w tym generowania zawartości, podsumowywania, wyszukiwania semantycznego i nie tylko.
Aplikacja logiki Aplikacje logiki umożliwiają orkiestrowanie i automatyzowanie przepływów pracy i integracji z różnymi źródłami danych.
App Service Interfejs API hostowany w usłudze app service na platformie Azure.
Aplikacja funkcji Kod bezserwerowy, który można wywoływać za pomocą wyzwalaczy.
Aplikacja kontenera Kontenery bezserwerowe dla mikrousług.

Importowanie interfejsu API

Istnieje kilka sposobów importowania interfejsu API do usługi Azure API Management.

W przypadku używania witryny Azure Portal wybierz pozycję Interfejsy API, a następnie pozycję + Dodaj interfejs API. Zacznij od wybrania typu interfejsu API, który chcesz zaimportować.

Zrzut ekranu witryny Azure Portal przedstawiający usługę API Management z wyróżnioną i wybraną sekcją interfejsów API.

Następnie podaj link do specyfikacji swojego interfejsu API w postaci adresu URL lub pliku oraz wprowadź nazwę interfejsu API. Oto przykład importowania interfejsu OpenAPI.

Zrzut ekranu przedstawiający tworzenie z ustawień importowania specyfikacji interfejsu OpenAPI ze specyfikacją interfejsu OpenAPI i wyróżnionymi polami nazwy wyświetlanej.

Witryna Azure Portal nie jest najbardziej wydajnym narzędziem do importowania i konfigurowania dużej liczby interfejsów API. Podczas skalowania w górę usługi API Management potrzebne są inne narzędzia, takie jak interfejs wiersza polecenia platformy Azure, usługa Azure Resource Manager lub szablony Bicep lub program Azure PowerShell. Można na przykład użyć poleceń cmdlet programu Azure PowerShell do wdrażania bram interfejsu API, definiowania i konfigurowania produktów, importowania interfejsów API oraz zarządzania użytkownikami i subskrypcjami.

Wizualizacja

Przy użyciu bramy interfejsów API można zwizualizować sposób przetwarzania danych za pośrednictwem zaimportowanych interfejsów API. Za pomocą interfejsów API można wchodzić w interakcje z zestawami danych i przekazywać parametry.

Jeśli jesteś administratorem, możesz wizualizować interfejsy API w witrynie Azure Portal.

Zrzut ekranu przedstawiający konfigurację interfejsu API witryny Azure Portal z wyróżnionym testem żądania GET w zaimportowanym interfejsie API.

Zasady

Zasady zapewniają zaawansowane możliwości zmieniania zachowania interfejsu API za pomocą konfiguracji. Jest to zbiór instrukcji, które są wykonywane sekwencyjnie podczas żądania lub odpowiedzi interfejsu API.

Popularne konfiguracje są m.in. następujące:

  • Konwersja z formatu XML na format JSON
  • Określanie limitu liczby wywołań w celu ograniczenia liczby wywołań przychodzących.
  • Ustawianie nagłówków ruchu przychodzącego i wychodzącego.

Witryna Azure Portal umożliwia stosowanie różnych zasad do interfejsów API. Zasady można wyświetlić na karcie Projektowanie.

Zrzut ekranu witryny Azure Portal przedstawiający konfigurację interfejsu API dla wszystkich operacji z wyróżnionymi zasadami podstawowymi dla sekcji ruchu przychodzącego, wychodzącego i zaplecza.

Możesz również użyć karty Projektowanie , aby dodać nowe zasady.

Zrzut ekranu witryny Azure Portal przedstawiający opcje zasad dla ruchu przychodzącego dla konfiguracji interfejsu API.

Rezultat

Produkt to kolekcja interfejsów API. Interfejsy API można przypisać do więcej niż jednego produktu. Możesz na przykład chcieć, aby jeden produkt, NorthWindShoesPartners, uwidaczniał dwa interfejsy API dla partnerów:

Rezultat NorthWindShoesPartners
API 1 Spis
API 2 Planowanie

Dla dostawców możesz chcieć uwidocznić tylko jeden interfejs API:

Rezultat NorthWindShoesSuppliers
API 1 Spis
API 2

Zasady przypisuje się po to, aby produkty mogły mieć różne reguły dostępu, limity przydziałów użycia i warunki użytkowania. Jeśli więc chcesz, aby partnerzy i dostawcy mieli różne uprawnienia dostępu do Twojego interfejsu API Spis, przypisz ten interfejs API do dwóch różnych produktów.

W celu skojarzenia interfejsów API z produktem można użyć witryny Azure Portal.

Zrzut ekranu witryny Azure Portal przedstawiający usługę API Management z wyróżnioną sekcją produktów.

W kilku warstwach cenowych istnieją dwa domyślne produkty: Starter i Unlimited. Produkt Unlimited jest przeznaczony do zarządzania interfejsami API w środowisku produkcyjnym, ponieważ nie ma żadnych ograniczeń dotyczących liczby dołączonych interfejsów API. Możesz utworzyć tyle nowych produktów, ile potrzebujesz. Produkt Starter ma limit pięciu wywołań interfejsu API na minutę i maksymalnie 100 wywołań interfejsu API na tydzień.