Zarządzanie interfejsami API za pomocą rozszerzenia Centrum interfejsów API platformy Azure dla programu Visual Studio Code

Aby zmaksymalizować sukces wysiłków związanych z ładem interfejsu API, kluczowe znaczenie ma przejście w lewo ładu na wczesnym etapie cyklu tworzenia interfejsu API. Takie podejście umożliwia deweloperom interfejsów API poprawne tworzenie interfejsów API od samego początku, uchronienie ich przed marnowaniem wysiłku programistycznego i zapobieganie powstawaniu niezgodnych interfejsów API na późniejszych etapach procesu programowania.

Rozszerzenie Azure API Center dla programu Visual Studio Code obejmuje następujące możliwości zarządzania dla deweloperów API:

• Ocenianie projektów interfejsów API względem przewodników stylu interfejsu API podczas tworzenia interfejsu API w programie Visual Studio Code.
• Wczesne wykrywanie zmian powodujących niezgodność, dzięki czemu interfejsy API pozostają niezawodne i działają zgodnie z oczekiwaniami, zachowując zaufanie użytkowników końcowych i interesariuszy.

Deweloperzy interfejsu API mogą również korzystać z funkcji w rozszerzeniu, aby rejestrować interfejsy API w centrum interfejsów API i odnajdywać interfejsy API i korzystać z nich.

Wymagania wstępne

• Visual Studio Code

• Rozszerzenie Centrum interfejsu API platformy Azure dla programu Visual Studio Code

• Co najmniej jedno centrum API w subskrypcji Azure. Centrum interfejsów API można utworzyć przy użyciu rozszerzenia Centrum interfejsu API platformy Azure lub innych narzędzi.

  • Obecnie musisz mieć przypisaną rolę Współautora Usługi Centrum Interfejsów API platformy Azure lub posiadać wyższe uprawnienia w centrum interfejsów API, aby zarządzać interfejsami API za pomocą rozszerzenia.

• Rozszerzenie Spectral dla programu Visual Studio Code — do uruchamiania kontroli zgodności projektów API typu shift-left w programie Visual Studio Code
• Optic CLI — wykrywanie zmian powodujących niezgodności między dokumentami specyfikacji API.

Konfiguracja rozszerzenia

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.

   

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 API (lub centrami API), z którego chcesz wyświetlić interfejsy API. Możesz również filtrować określone subskrypcje, jeśli masz wiele do wyświetlenia.

Zgodność projektu interfejsu API

Aby zapewnić zgodność projektu ze standardami organizacyjnymi podczas tworzenia interfejsów API, rozszerzenie Centrum interfejsów API platformy Azure dla programu Visual Studio Code zapewnia zintegrowaną obsługę lintingu specyfikacji interfejsu API z funkcją Spectral.

1. Użyj skrótu klawiaturowego Ctrl+Shift+P , aby otworzyć paletę poleceń. Wpisz Azure API Center: Ustaw aktywny Przewodnik Stylu API i naciśnij Enter.
2. Wybierz jedną z podanych reguł domyślnych lub, jeśli Twoja organizacja ma już dostępny przewodnik stylu, użyj opcji Wybierz lokalny plik lub Wprowadź zdalny URL do określenia aktywnego zestawu reguł w Visual Studio Code. Naciśnij Enter.

Po ustawieniu aktywnego przewodnika stylu interfejsu API otwieranie dowolnego pliku specyfikacji opartego na standardzie OpenAPI lub AsyncAPI wyzwala lokalną operację lintingu w programie Visual Studio Code. Wyniki są wyświetlane bezpośrednio w edytorze oraz w oknie Problemy (Wyświetl>Problemy lub Ctrl+Shift+M).

Wykrywanie niekompatybilnych zmian

Podczas wprowadzania nowych wersji interfejsu API ważne jest, aby upewnić się, że wprowadzone zmiany nie przerywają użytkowników interfejsu API w poprzednich wersjach interfejsu API. Rozszerzenie Centrum interfejsu API platformy Azure dla programu Visual Studio Code ułatwia wykrywanie niezgodnych zmian w dokumentach specyfikacji OpenAPI dzięki technologii Optic.

1. Użyj skrótu klawiaturowego Ctrl+Shift+P , aby otworzyć paletę poleceń. Wpisz Azure API Center: Detect Breaking Change i naciśnij Enter.
2. Wybierz pierwszy dokument specyfikacji interfejsu API do porównania. Prawidłowe opcje obejmują specyfikacje interfejsu API znalezione w centrum interfejsu API, pliku lokalnego lub aktywnego edytora w programie Visual Studio Code.
3. Wybierz drugi dokument specyfikacji interfejsu API do porównania. Prawidłowe opcje obejmują specyfikacje interfejsu API znalezione w centrum interfejsu API, pliku lokalnego lub aktywnego edytora w programie Visual Studio Code.

Program Visual Studio Code otwiera widok różnic między dwoma specyfikacjami interfejsu API. Wszelkie niezgodne zmiany są wyświetlane zarówno bezpośrednio w edytorze, jak i w oknie Problemy (Widok>Problemy lub Ctrl+Shift+M).

Powiązana zawartość

• Centrum interfejsów API platformy Azure — kluczowe pojęcia
• Kompilowanie i rejestrowanie interfejsów API za pomocą rozszerzenia Centrum interfejsów API platformy Azure dla programu Visual Studio Code
• Odnajdywanie interfejsów API i korzystanie z nich za pomocą rozszerzenia Centrum interfejsów API platformy Azure dla programu Visual Studio Code
• Włączanie i wyświetlanie portalu Centrum interfejsów API w programie Visual Studio Code