Odnajdywanie i użycie interfejsu API

Ukończone

Odnajdywanie i używanie interfejsów API jest ważną częścią korzystania z interfejsów API w całej organizacji.

W tej lekcji dowiesz się, jak rozszerzenie programu VS Code centrum interfejsów API umożliwia łatwe odnajdywanie i używanie interfejsów API.

Wymagania wstępne

Aby zarządzać interfejsami API za pomocą rozszerzenia centrum interfejsów API w programie VS Code, należy wykonać następujące kroki:

• Instalacja programu Visual Studio Code
• Instalowanie rozszerzenia centrum interfejsu API

Następujące rozszerzenia programu Visual Studio Code są opcjonalne i potrzebne tylko dla niektórych scenariuszy, jak wskazano:

• Rozszerzenie klienta REST — aby wysyłać żądania HTTP i wyświetlać odpowiedzi bezpośrednio w programie Visual Studio Code.
• Rozszerzenie Microsoft Kiota — w celu wygenerowania klientów interfejsu API.

Odnajdywanie i użycie interfejsu API

Katalog interfejsów API organizacji można wyświetlić bezpośrednio w programie Visual Studio Code ze wszystkimi interfejsami API, wersjami, definicjami, środowiskami i wdrożeniami. Dzięki jednemu rzutowi oka możesz natychmiast zapoznać się ze wszystkimi interfejsami API dostępnymi w organizacji.

Ale co zrobić, jeśli Twoja organizacja ma setki lub tysiące interfejsów API? Nie martw się, możesz wyszukać interfejsy API za pomocą ikony wyszukiwania, jak pokazano poniżej.

Wyświetlanie dokumentacji interfejsu API

Możesz również szybko uzyskać dostęp do dokumentacji interfejsu API w wersji zapoznawczej i przetestować punkty końcowe dla interfejsów API w programie VS Code.

1. Otwórz rozszerzenie centrum interfejsu API na karcie .
2. Rozwiń widok drzewa Centrum interfejsu API, aby wyświetlić definicję interfejsu API.
3. Kliknij prawym przyciskiem myszy definicję i wybierz pozycję Otwórz dokumentację interfejsu API.
4. Zostanie wyświetlona nowa karta z interfejsem użytkownika struktury Swagger dla definicji interfejsu API.
5. Wybierz punkt końcowy i wybierz pozycję Wypróbuj, podaj wymagane parametry i wybierz pozycję Wykonaj.

Wypróbuj interfejsy API

Za pomocą rozszerzenia centrum interfejsu API można wyświetlić plik HTTP na podstawie definicji interfejsu API podanej w Centrum interfejsu API. W tym pliku można bezpośrednio wysyłać żądania HTTP i wyświetlać odpowiedzi bezpośrednio w edytorze.

Uwaga

Aby korzystać z tej możliwości, należy zainstalować rozszerzenie klienta REST.

1. Rozwiń widok drzewa Centrum interfejsu API, aby wyświetlić definicję interfejsu API.
2. Kliknij prawym przyciskiem myszy definicję i wybierz polecenie Generuj plik HTTP.
3. Zostanie wyświetlona nowa karta, która renderuje dokument HTTP wypełniony przez specyfikację interfejsu API.
4. Aby wysłać żądanie, wybierz punkt końcowy i wybierz pozycję Wyślij żądanie.

Generowanie zestawów SDK

Rozszerzenie API Center używa również rozwiązania Microsoft Kiota do generowania klienta dla interfejsu API REST PROTOKOŁU HTTP dla ulubionego języka zgodnie ze specyfikacją interfejsu OpenAPI. Dzięki temu można natychmiast wygenerować klientów dla wszystkich lub wybranych punktów końcowych dla interfejsu API, które spełniają Twoje potrzeby biznesowe.

Uwaga

Aby korzystać z tej możliwości, musisz zainstalować rozszerzenie Microsoft Kiota.

1. Rozwiń widok drzewa Centrum interfejsu API, aby wyświetlić definicję interfejsu API.

2. Kliknij prawym przyciskiem myszy definicję i wybierz pozycję Generuj klienta interfejsu API. Zostanie wyświetlone okienko Generator OpenAPI Kiota.

3. Wybierz punkty końcowe interfejsu API i operacje HTTP, które chcesz uwzględnić w zestawach SDK. Możesz zatrzymać wskaźnik myszy na punkcie końcowym i wybrać przycisk "+", aby go dodać lub "-", aby go usunąć.

4. Po zakończeniu wybierz przycisk "Odtwórz", aby wygenerować klienta interfejsu API.

5. Wybierz pozycję Generuj klienta interfejsu API.

   a. Wprowadź szczegóły konfiguracji dotyczące nazwy zestawu SDK, przestrzeni nazw i katalogu wyjściowego.

   b. Wybierz język wygenerowanego zestawu SDK.

Portal Centrum interfejsów API (Self-hosted)

Portal usługi API Center to witryna internetowa dla deweloperów i uczestników projektu, która umożliwia bezproblemowe odnajdywanie interfejsów API i kontaktowanie się z interfejsami API w spisie interfejsów API. Dzięki tej własnej witrynie internetowej organizacje zapewniają użytkownikom środowisko odnajdywania i użycia interfejsu API opartego na sieci Web.

Inżynierowie platformy API chcą scentralizowanej i autonomicznej lokalizacji dla wszystkich użytkowników interfejsu API, zarówno wewnętrznych, jak i zewnętrznych. Aby rozpocząć pracę, możesz użyć szablonu startowego portalu API Center, wykonując następujące kroki:

Uwaga

Poniższe instrukcje dotyczą wdrażania w usłudze Azure Static Web Apps, ale możesz wdrożyć w wybranej infrastrukturze.

1. Rozwidlenie kodu implementacji referencyjnej centrum interfejsu API.

2. Utwórz zasób statycznej aplikacji internetowej na platformie Azure.

3. W obszarze Szczegóły wdrożenia wybierz pozycję GitHub jako źródło i przejdź do repozytorium zawierającego kod początkowy centrum interfejsu API.

4. Usługa Static Web Apps wykryje ustawienia wstępne kompilacji i wypełni aplikację React.

5. Wprowadź / jako lokalizację aplikacji.

6. Wprowadź dist jako lokalizację danych wyjściowych .

7. Wybierz pozycję Utwórz.

   

Opublikowanie kodu w witrynie internetowej może potrwać do 5 minut.

Aby wyświetlić portal Centrum interfejsów API działający w usłudze Static Web Apps, wybierz pozycję Wyświetl aplikację w przeglądarce na karcie Przegląd w zasobie Statyczna aplikacja internetowa utworzona w witrynie Azure Portal.

Konfigurowanie kontroli dostępu opartej na rolach

Administratorzy mają pełną kontrolę nad przypisywaniem uprawnień dostępu do interfejsów API i zasobów w Centrum interfejsów API organizacji przy użyciu kontroli dostępu opartej na rolach.

Uwaga

Domyślnie administratorzy centrum interfejsu API nie mają dostępu do interfejsów API w portalu Centrum interfejsów API. Pamiętaj, aby przypisać rolę Czytelnik danych centrum interfejsu API platformy Azure do siebie i innych administratorów.

Aby uzyskać dostęp do interfejsów API w Centrum interfejsów API, użytkownicy muszą zalogować się do portalu i muszą mieć niezbędne uprawnienia w zakresie centrum interfejsów API. Aby włączyć logowanie, przypisz rolę Czytelnik danych centrum interfejsu API platformy Azure do użytkowników lub grup w organizacji, wykonując kroki podane tutaj.