Freigeben über

Steuern von APIs mit der Azure API-Center-Erweiterung für Visual Studio Code

Um den Erfolg der API Governance zu maximieren, ist es wichtig, die Governance frühzeitig in den API-Entwicklungszyklus zu verlagern. Dieser Ansatz ermöglicht es API-Entwicklern, APIs von Anfang an korrekt zu erstellen, was ihnen Entwicklungsaufwand erspart und so nicht konforme APIs später im Entwicklungsprozess vermieden werden.

Die Azure API Center-Erweiterung für Visual Studio Code enthält die folgenden Governancefunktionen für Fachkräfte in der API-Entwicklung:

  • Auswertung der API-Designs anhand von API-Styleguides, da die API in Visual Studio Code entwickelt wird.
  • Frühzeitige Erkennung von änderungen, sodass APIs zuverlässig und erwartungsgemäß funktionieren und das Vertrauen von Endbenutzern und Projektbeteiligten erhalten bleiben.

API-Entwickler können auch Features in der Erweiterung nutzen, um APIs im API Center zu registrieren und APIs zu entdecken und zu nutzen.

Voraussetzungen

Erweiterungs-Setup

Richten Sie die Erweiterung wie folgt ein:

  1. Installieren Sie die Azure API-Center-Erweiterung für Visual Studio Code aus dem Visual Studio Code Marketplace. Installieren Sie nach Bedarf weitere Erweiterungen.

    Hinweis

    Die [PREVIEW] Notation gibt features an, die nur in der Vorabversion der Azure API Center-Erweiterung verfügbar sind. Wenn Sie die Erweiterung aus dem Visual Studio Code Marketplace installieren, können Sie die Releaseversion oder eine Vorabversion (wie verfügbar) installieren. Um zwischen installierten Versionen zu wechseln, wählen Sie in der Erweiterungsansicht in Visual Studio Code die Schaltfläche "Verwalten" (Zahnradsymbol) aus.

  2. Wählen Sie in Visual Studio Code in der Aktivitätsleiste API Center aus:

    Screenshot des Api Center-Erweiterungssymbols in der Visual Studio Code-Aktivitätsleiste.

  3. Wenn Sie nicht bei Ihrem Azure-Konto angemeldet sind, wählen Sie "Bei Azure anmelden" aus, und folgen Sie den Anweisungen zum Anmelden.

  4. Wählen Sie ein Azure-Abonnement mit den API-Zentren aus, die die APIs enthalten, die angezeigt werden sollen. Wenn Sie über mehrere Konten verfügen, können Sie nach bestimmten Abonnements filtern.

API-Designkonformität

Um die Designkonformität mit organisatorischen Standards beim Erstellen von APIs sicherzustellen, bietet die Azure API-Center-Erweiterung für Visual Studio Code integrierte Unterstützung für das Linting der API-Spezifikation mit Spectral.

  1. Verwenden Sie das Tastaturkürzel Strg+Umschalt+P, um die Befehlspalette zu öffnen. Geben Sie Azure API Center: den aktiven API-Stil-Leitfaden festlegen gefolgt von der Eingabetaste ein.

  2. Wählen Sie eine der bereitgestellten Standardregeln aus. Wenn Ihre Organisation bereits über eine Formatvorlage verfügt, wählen Sie die Option "Lokale Datei oder Eingabe-Remote-URL auswählen" aus, und geben Sie das aktive Regelet in Visual Studio Code an. Wählen Sie Geben Sieein.

Nachdem eine aktive API-Stilanleitung festgelegt wurde, löst das Öffnen einer OpenAPI- oder AsyncAPI-basierten Spezifikationsdatei einen lokalen Lintingvorgang in Visual Studio Code aus. Die Ergebnisse werden sowohl inline im Editor als auch im Fenster Probleme angezeigt (Ansicht>Probleme oder Strg+Umschalt+M).

Screenshot der lokalen Lint-Prüfung in Visual Studio Code.

Erkennung von Breaking Changes

Bei der Einführung neuer Versionen Ihrer API ist es wichtig sicherzustellen, dass die eingeführten Änderungen API-Nutzer in früheren Versionen Ihrer API nicht beeinträchtigen. Die Erweiterung Azure API Center für Visual Studio Code erleichtert diese Aufgabe durch die Erkennung fehlerhafter Änderungen in OpenAPI-Spezifikationsdokumenten, die von Optic unterstützt werden.

  1. Verwenden Sie die Tastenkombination Ctrl+Shift+P, um die Befehlspalette zu öffnen. Geben Sie Azure API Center: Wichtige Änderungen erkennen gefolgt von der Eingabetaste ein.

  2. Wählen Sie das erste API-Spezifikationsdokument für den Vergleich aus. Zu den gültigen Optionen gehören API-Spezifikationen, die sich in API Center, in einer lokalen Datei oder im aktiven Editor in Visual Studio Code befinden.

  3. Wählen Sie das zweite API-Spezifikationsdokument für den Vergleich aus. Zu den gültigen Optionen gehören API-Spezifikationen, die sich in API Center, in einer lokalen Datei oder im aktiven Editor in Visual Studio Code befinden.

Visual Studio Code öffnet eine Diff-Ansicht für die beiden API-Spezifikationen. Fehlerhafte Änderungen werden sowohl inline im Editor als auch im Fenster Probleme angezeigt (Ansicht>Probleme oder Strg+Umschalt+M).

Screenshot der in Visual Studio Code erkannten Breaking Changes

Zugehöriger Inhalt

  • Last updated on