Udostępnij za pośrednictwem

Kompilowanie i rejestrowanie interfejsów API za pomocą rozszerzenia Centrum interfejsów API platformy Azure dla programu Visual Studio Code

  • Artykuł

Deweloperzy interfejsów API w organizacji mogą tworzyć i rejestrować interfejsy API w spisie centrum interfejsów API przy użyciu rozszerzenia Centrum interfejsu API platformy Azure dla programu Visual Studio Code. Deweloperzy interfejsu API mogą wykonywać następujące czynności:

  • Dodaj istniejący interfejs API do centrum interfejsu API jako jednorazową operację lub zintegruj potok programowania, aby zarejestrować interfejsy API w ramach przepływu pracy ciągłej integracji/ciągłego wdrażania.
  • Użyj narzędzia GitHub Copilot, aby wygenerować nowe specyfikacje interfejsu OpenAPI na podstawie kodu interfejsu API.
  • Użyj monitów języka naturalnego z wtyczką Centrum interfejsu API dla narzędzia GitHub Copilot dla platformy Azure, aby utworzyć nowe specyfikacje interfejsu OpenAPI.

Deweloperzy interfejsu API mogą również korzystać z funkcji w rozszerzeniu w celu odnajdywania i korzystania z interfejsów API w centrum interfejsu API oraz zapewnienia ładu interfejsu API.

Wymagania wstępne

W określonych scenariuszach potrzebne są następujące rozszerzenia programu Visual Studio Code:

  • GitHub Actions — rejestrowanie interfejsów API przy użyciu potoku ciągłej integracji/ciągłego wdrażania za pomocą funkcji GitHub Actions
  • Azure Pipelines — aby zarejestrować interfejsy API przy użyciu potoku ciągłej integracji/ciągłego wdrażania w usłudze Azure Pipelines
  • GitHub Copilot — generowanie plików specyfikacji interfejsu OpenAPI na podstawie kodu interfejsu API
  • GitHub Copilot dla platformy Azure — generowanie plików specyfikacji interfejsu OpenAPI przy użyciu wtyczki Centrum interfejsu API platformy Azure dla usługi GitHub Copilot dla platformy Azure (wersja zapoznawcza)

Ustawienia

  1. Zainstaluj rozszerzenie Centrum interfejsu API platformy Azure dla programu Visual Studio Code z witryny Visual Studio Code Marketplace. Zainstaluj inne rozszerzenia zgodnie z potrzebami.

    Uwaga

    Jak wspomniano, niektóre funkcje są dostępne tylko w wersji wstępnej rozszerzenia usługi Azure API Center. Podczas instalowania rozszerzenia z witryny Marketplace programu Visual Studio Code możesz zainstalować wersję wydania lub wersję wstępną. Przełączanie między dwiema wersjami w dowolnym momencie przy użyciu menu kontekstowego przycisku Zarządzaj rozszerzeniem w widoku Rozszerzenia.

  2. W programie Visual Studio Code na pasku działań po lewej stronie wybierz pozycję Centrum interfejsu API.

    Zrzut ekranu przedstawiający rozszerzenie centrum interfejsu API na pasku działań.

  3. Jeśli nie zalogowałeś się do konta platformy Azure, wybierz pozycję Zaloguj się do platformy Azure..., a następnie postępuj zgodnie z monitami, aby się zalogować. Wybierz subskrypcję platformy Azure z centrum interfejsu API (lub centrami interfejsów API), z których chcesz wyświetlić interfejsy API. Możesz również filtrować określone subskrypcje, jeśli masz wiele do wyświetlenia.

Rejestrowanie interfejsu API — krok po kroku

Poniższe kroki rejestrują interfejs API w centrum interfejsu API jako jednorazową operację.

  1. Użyj skrótu klawiaturowego Ctrl+Shift+P , aby otworzyć paletę poleceń. Wpisz Centrum interfejsów API platformy Azure: Zarejestruj interfejs API i naciśnij Enter.
  2. Wybierz pozycję Ręczne.
  3. Wybierz centrum interfejsów API, aby zarejestrować interfejsy API za pomocą polecenia .
  4. Monity odpowiedzi z informacjami, w tym tytuł interfejsu API, typ, tytuł wersji, cykl życia wersji, tytuł definicji, nazwa specyfikacji i plik definicji w celu ukończenia rejestracji interfejsu API.

Interfejs API jest dodawany do spisu centrum interfejsu API.

Rejestrowanie interfejsów API — potok ciągłej integracji/ciągłego wdrażania

Poniższe kroki umożliwiają zarejestrowanie interfejsu API w centrum interfejsu API za pomocą potoku ciągłej integracji/ciągłego wdrażania. Dzięki tej opcji dodaj wstępnie skonfigurowany potok GitHub lub Azure DevOps do aktywnego obszaru roboczego programu Visual Studio Code, który jest uruchamiany jako część przepływu pracy ciągłej integracji/ciągłego wdrażania w każdym zatwierdzeniu kontroli źródła. Zaleca się spis interfejsów API z centrum interfejsów API przy użyciu ciągłej integracji/ciągłego wdrażania, aby zapewnić, że metadane interfejsu API, w tym specyfikacja i wersja pozostają aktualne w centrum interfejsu API, ponieważ interfejs API nadal ewoluuje wraz z upływem czasu.

  1. Użyj skrótu klawiaturowego Ctrl+Shift+P , aby otworzyć paletę poleceń. Wpisz Centrum interfejsów API platformy Azure: Zarejestruj interfejs API i naciśnij Enter.
  2. Wybierz pozycję Ciągła integracja/ciągłe wdrażanie.
  3. Wybierz pozycję GitHub lub Azure DevOps w zależności od preferowanego mechanizmu kontroli źródła. Aby dodać potok do obszaru roboczego, obszar roboczy programu Visual Studio Code musi być otwarty dla rozszerzenia Centrum interfejsu API platformy Azure. Po dodaniu pliku wykonaj kroki opisane w samym pliku potoku ciągłej integracji/ciągłego wdrażania, aby skonfigurować wymagane zmienne środowiskowe i tożsamość. W przypadku wypychania do kontroli źródła interfejs API jest zarejestrowany w Centrum interfejsu API.

Dowiedz się więcej o konfigurowaniu przepływu pracy funkcji GitHub Actions w celu rejestrowania interfejsów API w centrum interfejsu API.

Generowanie specyfikacji interfejsu OpenAPI na podstawie kodu interfejsu API

Użyj możliwości narzędzia GitHub Copilot z rozszerzeniem Centrum interfejsu API platformy Azure dla programu Visual Studio Code, aby utworzyć plik specyfikacji interfejsu OpenAPI na podstawie kodu interfejsu API. Kliknij prawym przyciskiem myszy kod interfejsu API, wybierz pozycję Copilot z opcji i wybierz pozycję Generuj dokumentację interfejsu API. Narzędzie GitHub Copilot tworzy plik specyfikacji interfejsu OpenAPI.

Uwaga

Ta funkcja jest dostępna w wersji wstępnej rozszerzenia centrum interfejsu API.

Animacja przedstawiająca sposób używania narzędzia GitHub Copilot do generowania specyfikacji interfejsu OpenAPI na podstawie kodu.

Po wygenerowaniu pliku specyfikacji interfejsu OpenAPI i sprawdzeniu dokładności możesz zarejestrować interfejs API w centrum interfejsu API przy użyciu centrum interfejsu API platformy Azure: zarejestruj interfejs API .

Generowanie specyfikacji interfejsu OpenAPI przy użyciu monitów języka naturalnego

Wtyczka usługi API Center dla narzędzia GitHub Copilot dla platformy Azure (wersja zapoznawcza) ułatwia projektowanie nowych interfejsów API rozpoczynających się od monitów języka naturalnego. Dzięki pomocy w zakresie sztucznej inteligencji szybko wygeneruj specyfikację interfejsu OpenAPI na potrzeby tworzenia interfejsu API zgodnego ze standardami organizacji.

Uwaga

Ta funkcja jest dostępna w wersji wstępnej rozszerzenia centrum interfejsu API.

  1. W razie potrzeby ustaw aktywny przewodnik stylu interfejsu API. Użyj skrótu klawiaturowego Ctrl+Shift+P , aby otworzyć paletę poleceń. Wpisz Centrum interfejsów API platformy Azure: ustaw przewodnik stylu interfejsu API, wybierz i naciśnij Enter.

    Jeśli nie ustawiono żadnego przewodnika po stylu, zostanie użyty domyślny spectral:oas zestaw reguł.

  2. Na panelu czatu prześlij do agenta żądanie w języku @azure naturalnym, aby opisać, co robi interfejs API. Przykład:

    @azure Generate OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards.

    Agent odpowiada dokumentem specyfikacji interfejsu OpenAPI.

    Zrzut ekranu przedstawiający sposób używania rozszerzenia @azure do generowania specyfikacji interfejsu OpenAPI na podstawie monitu.

  3. Przejrzyj wygenerowane dane wyjściowe, aby uzyskać dokładność i zgodność z przewodnikiem po stylu interfejsu API. Uściślij monit, jeśli jest to konieczne, aby wygenerować ponownie.

    Napiwek

    Skuteczne monity koncentrują się na wymaganiach biznesowych interfejsu API, a nie na szczegółach implementacji. Krótsze monity czasami działają lepiej niż dłuższe.

  4. Jeśli spełnia ona wymagania, zapisz wygenerowaną specyfikację interfejsu OpenAPI do pliku.

  5. Zarejestruj interfejs API w centrum interfejsu API. Wybierz przycisk Zarejestruj interfejs API w centrum interfejsu API w panelu czatu lub wybierz pozycję Centrum interfejsu API platformy Azure: Zarejestruj interfejs API z palety poleceń i postępuj zgodnie z monitami.

Powiązana zawartość