fb
API Management 4 min

Benutzerdefinierte API-Eigenschaften für eine bessere API-Governance

Dinusha
api management
Scrollen

APIs sind ein wichtiger technischer Aspekt, um die Werte der Unternehmen und den Weg der digitalen Transformation zu fördern. Der WSO2 API Manager ist ein All-in-One-Produkt für das API-Management, mit dem der gesamte API-Lebenszyklus einer API mit einer Vielzahl von Funktionen gemanagt werden kann.

Mit den APIs können Unternehmen ihre Fähigkeiten auf interessierte Parteien ausweiten. Mit der Expansion und dem Wachstum eines Unternehmens kann die Anzahl der verfügbaren APIs schnell wachsen, da immer mehr Anwendungsfälle innerhalb des Unternehmens angefordert werden. Da APIs auf dem Weg zur digitalen Transformation eine Schlüsselrolle spielen, ist eine gute API-Governance und -Verwaltung unerlässlich, um den maximalen Nutzen aus den APIs zu ziehen.

APIs bestehen aus einer Reihe vordefinierter Standardeigenschaften wie API-Name, -Version und -Kontext, die bei der Identifizierung der API-Merkmale hilfreich sein können. Neben diesen Eigenschaften können die API-Ersteller und -Herausgeber den APIs zusätzliche Schlüssel-Wert-Paare hinzufügen. Diese zusätzlichen Eigenschaften werden als „benutzerdefinierte API-Eigenschaften“ bezeichnet.

Dieser Artikel enthält eine grundlegende Übersicht über benutzerdefinierte API-Eigenschaften und wie diese Funktion zur Verbesserung der API-Governance und -Verwaltung beiträgt.

Die API-Eigenschaften sind ein Schlüssel-Wert-Paar. Aber sie sollten:

  • Einzigartig sein
  • Keine Leerzeichen haben
  • Die Groß- und Kleinschreibung beachten
  • Auf nicht-reservierten Schlüsselwörtern basieren

Warum sind die benutzerdefinierten API-Eigenschaften wichtig?

  • Die Durchsuchbarkeit der APIs ist besser
  • Benutzerdefinierte API-Eigenschaften können gezielt im Entwicklerportal angezeigt werden
  • Die API-Managementrichtlinien einer API können anhand benutzerdefinierter Eigenschaften geändert werden

API-Eigenschaften können mittels der folgenden zwei Methoden zu einer API hinzugefügt werden;

  • Über das API Manager Herausgeberportal UI, weitere Informationen dazu in der WSO2-Dokumentation.()
  • Über das API Manager Herausgeberprodukt REST APIs, weitere Informationen dazu in der WSO2-Dokumentation.

Wenn Sie mehrere APIs haben, müssen Sie diese filtern oder schnell im Entwickler- oder Herausgeberportal durchsuchen. Bei einer wachsenden Anzahl von APIs in Ihrem Unternehmen kann es jedoch schwierig sein, eine API oder eine Reihe von APIs zu identifizieren. Mit den benutzerdefinierten API-Eigenschaften können Sie eine bessere Suchleistung erzielen.

Sie können das Schlüssel-Wert-Paar der API-Eigenschaft einfach in die Suchleiste eingeben, und es werden nur die APIs aufgelistet, die zu den entsprechenden API-Eigenschaften gehören. Dies führt zu einer besseren Benutzererfahrung und API-Governance.

Die API-Eigenschaften sind ein Schlüssel-Wert-Paar. Aber sie sollten:

  • Einzigartig sein
  • Keine Leerzeichen haben
  • Die Groß- und Kleinschreibung beachten
  • Auf nicht-reservierten Schlüsselwörtern basieren

Warum sind die benutzerdefinierten API-Eigenschaften wichtig?

  • Die Durchsuchbarkeit der APIs ist besser
  • Benutzerdefinierte API-Eigenschaften können gezielt im Entwicklerportal angezeigt werden
  • Die API-Managementrichtlinien einer API können anhand benutzerdefinierter Eigenschaften geändert werden

API-Eigenschaften können mittels der folgenden zwei Methoden zu einer API hinzugefügt werden;

  • Über das API Manager Herausgeberportal UI, weitere Informationen dazu in der WSO2-Dokumentation.()
  • Über das API Manager Herausgeberprodukt REST APIs, weitere Informationen dazu in der WSO2-Dokumentation.

Bessere API-Suche

Wenn Sie mehrere APIs haben, müssen Sie diese filtern oder schnell im Entwickler- oder Herausgeberportal durchsuchen. Bei einer wachsenden Anzahl von APIs in Ihrem Unternehmen kann es jedoch schwierig sein, eine API oder eine Reihe von APIs zu identifizieren. Mit den benutzerdefinierten API-Eigenschaften können Sie eine bessere Suchleistung erzielen.

Sie können das Schlüssel-Wert-Paar der API-Eigenschaft einfach in die Suchleiste eingeben, und es werden nur die APIs aufgelistet, die zu den entsprechenden API-Eigenschaften gehören. Dies führt zu einer besseren Benutzererfahrung und API-Governance.

api manager yenlo

Gesucht nach authentication:flow1

api manager

Gesucht nach authentication:flow2

API-Eigenschaften gezielt im Entwicklerportal anzeigen

Dank der Möglichkeit, benutzerdefinierte API-Eigenschaften im Entwicklerportal anzuzeigen, können Ihre API-Ersteller und -Herausgeber den API-Benutzern nur einen vordefinierten Satz von Eigenschaften anzeigen lassen. Wie in der folgenden Abbildung dargestellt, können Sie die API-Eigenschaft im Entwicklerportal anzeigen lassen, indem Sie einfach auf das Kästchen „Show in devportal“ („Im Entwicklungsportal anzeigen“) klicken.

api manager blog2

Wenn die benutzerdefinierten API-Eigenschaften so eingestellt sind, dass sie im Entwicklerportal sichtbar sind, können Sie basierend auf diesen Eigenschaften wie im Herausgeberportal nach APIs suchen.

api manager blog
api manager

Änderung der API Management-Richtlinie

Der WSO2 API Manager wendet API-Managementrichtlinien unter Verwendung des „handlers concept“ an, wobei jede der API-Richtlinien, wie z. B. die Authentifizierungsdrosselung, ihren eigenen Handler hat. Wenn eine Anpassung erforderlich ist, kann ein benutzerdefinierter Handler geschrieben und konfiguriert werden, der auf die APIs angewendet wird.

Die Logik zur Einbindung von Handlern kann so modifiziert werden, dass die spezifischen Handler für APIs basierend auf ihren benutzerdefinierten Eigenschaften verfügbar sind.

Wenn Sie beispielsweise über zwei Umgebungen und zwei verschiedene benutzerdefinierte Authentifizierungsabläufe verfügen, können Sie ganz einfach benutzerdefinierte API-Eigenschaften verwenden, um den entsprechenden umgebungsspezifischen benutzerdefinierten Authentifizierungs-Handler für eine API zu aktivieren.

Fazit

Benutzerdefinierte API-Eigenschaften sind eindeutige Schlüssel-Wert-Paare, die zu einer API gehören und einen Vorteil bei der API-Governance bieten.

Sie können einer API sowohl über die WSO2 API Manager Publisher REST API als auch über das Herausgeberportal UI hinzugefügt werden. Die benutzerdefinierten API-Eigenschaften tragen dazu bei, die Benutzerfreundlichkeit der API-Suche sowohl für Herausgeber als auch für Benutzer zu verbessern, und können außerdem gezielt für die Benutzer angezeigt werden. Darüber hinaus können API-Managementrichtlinien mittels benutzerdefinierter API-Eigenschaften selektiv auf APIs angewendet werden.