Udostępnij za pośrednictwem

Projektowanie i opracowywanie interfejsów API przy użyciu wtyczki usługi API Center dla usługi GitHub Copilot dla platformy Azure

  • Artykuł

Wtyczka usługi API Center dla narzędzia GitHub Copilot dla platformy Azure (wersja zapoznawcza) przyspiesza projektowanie i opracowywanie nowych interfejsów API, począwszy od monitów języka naturalnego. Dzięki pomocy w zakresie sztucznej inteligencji dostępnej za pośrednictwem wtyczki Centrum interfejsu API w połączeniu z rozszerzeniem programu VS Code centrum interfejsu API wystarczy opisać interfejs API i szybko wygenerować specyfikację interfejsu OpenAPI na potrzeby tworzenia interfejsu API zgodnego ze standardami organizacji. Po wygenerowaniu zgodnej specyfikacji możesz zarejestrować interfejs API w centrum interfejsu API.

Uwaga

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

Wymagania wstępne

Konfiguracja rozszerzenia

  1. Zainstaluj rozszerzenie Centrum interfejsu API platformy Azure dla programu Visual Studio Code z witryny Visual Studio Code Marketplace. Zainstaluj inne rozszerzenia wymienione w wymaganiach wstępnych.

    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.

Wysyłanie żądania do agenta @azure

Wykonaj następujące kroki, aby wygenerować specyfikację interfejsu OpenAPI przy użyciu monitów języka naturalnego za pomocą narzędzia GitHub Copilot dla platformy Azure:

  1. W razie potrzeby ustaw aktywny przewodnik stylu interfejsu API w rozszerzeniu Centrum interfejsu API platformy Azure. 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ł. Dowiedz się więcej na temat lintingu specyfikacji interfejsu API przy użyciu rozszerzenia centrum interfejsu API.

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

    @azure Generate an 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. Check that there are no duplicate keys.

    Copilot jest obsługiwany przez sztuczną inteligencję, więc możliwe są niespodzianki i błędy. Aby uzyskać więcej informacji, zobacz Copilot CZĘSTO zadawane pytania.

    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ść, kompletność i zgodność z przewodnikiem po stylu interfejsu API.

    Uściślij monit, jeśli jest to konieczne, aby ponownie wygenerować specyfikację, lub powtórz ten proces przy użyciu innego przewodnika stylowego ustawionego w rozszerzeniu Centrum interfejsu API Platformy Azure.

    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.

Rejestrowanie interfejsu API w centrum interfejsu API

Użyj rozszerzenia Centrum interfejsu API platformy Azure dla programu VS Code, aby zarejestrować interfejs API w centrum interfejsu API z wygenerowanego pliku specyfikacji. Po zarejestrowaniu interfejsu API możesz użyć rozszerzenia, aby wyświetlić dokumentację interfejsu API, wygenerować klienta HTTP, wykonać dalsze linting i analizę i nie tylko.

  1. W programie VS Code 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ń.

  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 (specyfikacja) w celu ukończenia rejestracji interfejsu API.

Po zarejestrowaniu interfejsu API można wykonywać różne zadania przy użyciu rozszerzenia . Na przykład wyświetl dokumentację interfejsu API w interfejsie użytkownika struktury Swagger:

  1. Rozwiń widok drzewa Centrum interfejsu API, aby wybrać definicję zarejestrowanej wersji interfejsu API.

  2. Kliknij prawym przyciskiem myszy definicję i wybierz pozycję Otwórz dokumentację interfejsu API. Zostanie wyświetlona nowa karta z interfejsem użytkownika struktury Swagger dla definicji interfejsu API.

Zrzut ekranu przedstawiający interfejs użytkownika programu Swagger w rozszerzeniu programu VS Code.

Powiązana zawartość