Samouczek: rejestrowanie interfejsów API w spisie interfejsów API

W tym samouczku wyjaśniono, jak rozpocząć spis interfejsów API w centrum interfejsu API organizacji, rejestrując interfejsy API i przypisując metadane przy użyciu portalu Azure.

Aby uzyskać więcej informacji na temat interfejsów API, wersji interfejsów API, definicji i innych jednostek, które można spisać w Centrum interfejsów API platformy Azure, zobacz Kluczowe pojęcia.

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

• Rejestrowanie co najmniej jednego interfejsu API
• Dodawanie wersji interfejsu API z definicją interfejsu API

Wymagania wstępne

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

• Co najmniej jeden interfejs API, który chcesz zarejestrować w centrum interfejsu API. Oto dwa przykłady z linkami do ich definicji interfejsu OpenAPI:

  • Swagger Petstore API
  • Interfejs API konferencji

• Zdefiniuj niestandardowe metadane dla interfejsów API, wykonując czynności z poprzedniego samouczka Definiowanie metadanych niestandardowych.

Rejestrowanie interfejsów API

Podczas rejestrowania (dodawania) interfejsu API w centrum interfejsu API rejestracja interfejsu API obejmuje następujące elementy:

• Tytuł (nazwa), typ i opis
• Informacje o wersji
• Opcjonalne linki do dokumentacji i kontaktów
• Zdefiniowane wbudowane i niestandardowe metadane

Po zarejestrowaniu interfejsu API można dodawać wersje i definicje do interfejsu API.

W poniższych krokach zarejestrowano dwa przykładowe interfejsy API: interfejs API programu Swagger Petstore i interfejs API konferencji (zobacz Wymagania wstępne). Jeśli wolisz, zarejestruj własne interfejsy API.

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ę Interfejsy> API+ Zarejestruj interfejs API.

3. Na stronie Rejestrowanie interfejsu API dodaj następujące informacje dotyczące interfejsu API programu Swagger Petstore. W dolnej części strony powinny zostać wyświetlone niestandardowe metadane linii biznesowej i skierowane do odbiorców zewnętrznych, które zdefiniowałeś w poprzednim samouczku.

   Setting	Wartość	Description
   Tytuł interfejsu API	Wprowadź interfejs API magazynu petstore programu Swagger.	Nazwa wybrana dla interfejsu API
   Identyfikator	Po wprowadzeniu poprzedniego tytułu centrum interfejsu API platformy Azure generuje ten identyfikator, który można zastąpić.	Nazwa zasobu platformy Azure dla interfejsu API
   Typ interfejsu API	Wybierz pozycję REST z listy rozwijanej.	Typ interfejsu API
   Podsumowanie	Opcjonalnie wprowadź podsumowanie.	Podsumowanie opisu interfejsu API
   Opis	Opcjonalnie wprowadź opis.	Opis interfejsu API
   wersja
   Tytuł wersji	Wprowadź wybrany tytuł wersji, taki jak wersja 1.	Nazwa wybrana dla wersji interfejsu API
   Identyfikacja wersji	Po wprowadzeniu poprzedniego tytułu centrum interfejsu API platformy Azure generuje ten identyfikator, który można zastąpić.	Nazwa zasobu platformy Azure dla wersji
   Cykl życia wersji	Wybierz z listy rozwijanej, na przykład Testowanie lub Produkcja.	Etap cyklu życia wersji interfejsu API
   Dokumentacja zewnętrzna	Opcjonalnie dodaj co najmniej jeden link do dokumentacji zewnętrznej.	Nazwa, opis i adres URL dokumentacji interfejsu API
   Licencja	Opcjonalnie dodaj informacje o licencji.	Nazwa, adres URL i identyfikator licencji dla interfejsu API
   Informacje o kontakcie	Opcjonalnie dodaj informacje dla co najmniej jednego kontaktu.	Nazwa, adres e-mail i adres URL kontaktu dla interfejsu API
   Działalność biznesowa	Jeśli te metadane zostały dodane w poprzednim samouczku, dokonaj wyboru z listy rozwijanej, takiej jak Marketing.	Niestandardowe metadane identyfikujące jednostkę biznesową będącą właścicielem interfejsu API
   Publiczne	Jeśli te metadane zostały dodane, zaznacz pole wyboru.	Niestandardowe metadane, które określają, czy interfejs API jest dostępny publicznie, czy tylko wewnętrzny

   

4. Wybierz pozycję Utwórz , aby zarejestrować interfejs API.

5. Powtórz poprzednie trzy kroki, aby zarejestrować inny interfejs API, taki jak interfejs API konferencji.

Wskazówka

Podczas rejestrowania interfejsu API w witrynie Azure Portal możesz wybrać dowolny ze wstępnie zdefiniowanych typów interfejsów API lub wprowadzić inny typ.

Interfejsy API są wyświetlane na stronie interfejsów API w portalu. Jeśli do centrum interfejsu API zostanie dodana duża liczba interfejsów API, użyj pola wyszukiwania i filtrów na tej stronie, aby znaleźć żądane interfejsy API.

Po zarejestrowaniu interfejsu API można wyświetlić lub edytować właściwości interfejsu API. Na stronie Interfejsy API wybierz interfejs API, aby wyświetlić strony do zarządzania rejestracją interfejsu API.

Dodawanie wersji interfejsu API

W całym cyklu życia interfejs API może mieć wiele wersji. Możesz dodać wersję do istniejącego interfejsu API w centrum interfejsu API, opcjonalnie z plikiem definicji lub plikami.

W tym miejscu dodasz wersję do jednego z interfejsów API:

1. W portalu Azure przejdź do centrum interfejsów API.

2. W menu paska bocznego wybierz pozycję Interfejsy API, a następnie wybierz interfejs API, na przykład Swagger Petstore.

3. Na stronie interfejsu API w obszarze Szczegóły wybierz pozycję .

   

4. Na stronie Dodawanie wersji interfejsu API wprowadź lub wybierz następujące informacje w obszarze Szczegóły wersji:

   Setting	Wartość	Description
   Tytuł wersji	Wprowadź wybrany tytuł wersji, taki jak wersja 2.	Nazwa wybrana dla wersji interfejsu API
   Identyfikacja wersji	Po wprowadzeniu poprzedniego tytułu centrum interfejsu API platformy Azure generuje ten identyfikator, który można zastąpić.	Nazwa zasobu platformy Azure dla wersji
   Cykl życia wersji	Wybierz z listy rozwijanej, taką jak Produkcja.	Etap cyklu życia wersji interfejsu API

5. Centrum interfejsów API platformy Azure obsługuje definicje w typowych formatach specyfikacji tekstu, takich jak OpenAPI 2 i 3 dla interfejsów API REST. Aby dodać definicję interfejsu API, wprowadź lub wybierz następujące informacje w obszarze Wybierz specyfikację:

   Setting	Wartość	Description
   Tytuł definicji	Wprowadź wybrany tytuł, taki jak definicja w wersji 2.	Nazwa wybrana dla definicji interfejsu API
   Identyfikacja definicji	Po wprowadzeniu poprzedniego tytułu centrum interfejsu API platformy Azure generuje ten identyfikator, który można zastąpić.	Nazwa zasobu platformy Azure dla definicji
   Opis	Opcjonalnie wprowadź opis.	Opis definicji interfejsu API
   Format specyfikacji	W przypadku interfejsu API magazynu petstore wybierz pozycję OpenAPI.	Format specyfikacji interfejsu API
   Wersja specyfikacji	Wprowadź wybrany identyfikator wersji, na przykład 3.0.	Wersja specyfikacji
   Plik lub adres URL	Przejdź do lokalnego pliku definicji dla interfejsu API magazynu petstore lub wprowadź adres URL. Przykładowy adres URL: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml	Plik definicji interfejsu API

   

6. Wybierz Utwórz.

Podczas tworzenia spisu interfejsów API skorzystaj z zautomatyzowanych narzędzi do rejestrowania interfejsów API, takich jak rozszerzenie Centrum interfejsów API platformy Azure dla programu Visual Studio Code i interfejsu wiersza polecenia platformy Azure.

Następny krok

Spis interfejsów API zaczyna kształtować się. Teraz możesz dodawać informacje o środowiskach interfejsu API i wdrożeniach.

Dodawanie środowisk i wdrożeń interfejsu API