Kommend | API7 DevPortal – Effizienz im API-Management auf die nächste Stufe heben

In der heutigen Computerwelt haben sich Menschen daran gewöhnt, APIs als Mittel zum Austausch von Informationen zwischen Softwareanwendungen zu verwenden. Ob Sie Wetterupdates auf Ihrem Telefon überprüfen, WeChat-Momente durchstöbern oder mit ChatGPT interagieren – all diese Aktionen werden durch APIs ermöglicht. APIs sind eine Reihe von Kommunikationskonventionen, die festlegen, wie Sie (oder Ihre Software) mit der Zielsoftware-Dienstleistung interagieren können.

API-Lebenszyklus-Management

Wenn ein Unternehmen wächst, kann die Anzahl der genutzten APIs schnell ansteigen. Wenn diese APIs nicht ordnungsgemäß verwaltet werden, kann dies zu einer Reihe von Problemen führen, wie erhöhte Personalkollaborationskosten, Dienstinstabilität und Sicherheitslücken. Um diese Bedenken zu adressieren, wurde das Konzept des API-Lebenszyklus-Managements entwickelt, um einen umfassenden Ansatz für das API-Management zu bieten.

Der API-Lebenszyklus kann in verschiedene Phasen von der Planung bis zur Außerbetriebnahme unterteilt werden und besteht typischerweise aus drei Phasen: Planung und Design, Implementierung und Management.

Planung und Design

Als Ingenieure betonen wir immer die Bedeutung der Lösungsgestaltung vor dem Schreiben von Code, und APIs sind keine Ausnahme. Wir müssen den Zweck einer API basierend auf den Geschäftsanforderungen definieren und die Geschäftssprache in technische Begriffe übersetzen, wobei wir den relevanten Technologie-Stack verwenden.

Typischerweise dreht sich die API-Planung und -Gestaltung um Dokumentation. Zum Beispiel sollte bei der Gestaltung einer RESTful API die API-Dokumentation die folgenden Informationen enthalten:

• API-Funktionsbeschreibung
• Entsprechende URL für die API
• HTTP-Anforderungsmethode
• Beschreibung (und Einschränkungen) von Anforderungsparametern, Anforderungskörper und Anforderungsheadern
• Mögliche Antwortstatuscodes und Antwortkörperbeschreibungen

Es gab viel Forschung darüber, wie man eine klare und umfassende API-Dokumentation schreibt, und derzeit ist der beliebte Ansatz die Verwendung der OpenAPI-Spezifikation V3.

In der realen Welt beinhaltet die API-Planung und -Gestaltung oft die Zusammenarbeit mehrerer Personen. Um diesem Bedarf gerecht zu werden, sind viele Plattformen, die sich der API-Planung und -Gestaltung widmen, auf dem Markt entstanden, wie z.B. Postman. Diese Tools ermöglichen es Benutzern, APIs visuell zu gestalten und bieten Kollaborationsfunktionen (meist in ihren kostenpflichtigen Versionen). Sie ermöglichen es Benutzern auch, APIs in einem bestimmten Format zu importieren und zu exportieren, um sie zu migrieren.

Implementierung

Sobald das API-Design abgeschlossen ist, können Ingenieure mit der Entwicklung beginnen. Sie können einen Technologie-Stack wählen, in dem sie geschickt sind oder den die Organisation für die Implementierung der API vorschreibt. Während der Entwicklung können Ingenieure die API auch testen, indem sie End-to-End-Tests hinzufügen oder Testanfragen an das QA-Team stellen. Sobald die Implementierung abgeschlossen ist, können Ingenieure dann die Bereitstellung der API vorbereiten.

Management-Phase

Im Vergleich zu den vorherigen Phasen ist die Management-Phase einer API komplexer, da sie Bereitstellung, Überwachung, Fehlerbehebung und Sicherheitsverstärkung umfasst. Hier spielt ein API-Gateway eine entscheidende Rolle. Das direkte Verfügbarmachen der Dienstinstanz nach der Bereitstellung ist weder sicher noch skalierbar.

Stattdessen fungiert ein API-Gateway als Proxy, der API-Anfragen an den tatsächlichen Dienst weiterleitet. Mit einem API-Gateway können Richtlinien wie Rate Limiting konfiguriert werden, um eine Überlastung des API-Dienstes zu verhindern, Authentifizierung, um nur autorisierten Benutzern Zugriff zu gewähren, und Beobachtbarkeit, um den API-Aufrufstatus in Echtzeit zu überwachen. Zusammenfassend ist ein API-Gateway eine wesentliche Komponente bei der Verwaltung der Sicherheit, Skalierbarkeit und Leistung einer API.

Tatsächlich sind APIs nicht statisch, und Ingenieure müssen ihre Funktionalität ständig iterieren und auftretende Mängel beheben. Daher werden APIs typischerweise zwischen den verschiedenen Phasen der Planung und Gestaltung, Implementierung und Management hin- und herwechseln, bevor sie vollständig außer Betrieb genommen werden. Dieser zyklische Prozess stellt sicher, dass APIs während ihres gesamten Lebenszyklus auf dem neuesten Stand und effektiv bleiben.

API-Nutzung

Das API-Lebenszyklus-Management vereinfacht die Verwaltung von APIs aus der Perspektive der API-Produzenten (d.h. API-Entwickler und -Betreuer). Es befasst sich jedoch nicht mit dem Problem der API-Nutzung, d.h. wie externe Entwickler (die aus verschiedenen Teams innerhalb desselben Unternehmens stammen können) die API einfach integrieren können. Um einem externen Entwickler zu ermöglichen, Ihre API aufzurufen, müssen mehrere Probleme gelöst werden:

• Das erste Problem, das gelöst werden muss, ist, wie externe Entwickler auf API-Informationen zugreifen können, einschließlich API-Zugriffsadressen, Beschreibungen, Parameterbeschränkungen, Verwendungsbeispiele und mehr. Solche detaillierten Informationen sind entscheidend, um externen Entwicklern zu helfen, die API zu verstehen und effektiv zu nutzen.
• Das zweite Problem betrifft den API-Schutz, der für API-Produzenten von entscheidender Bedeutung ist. Es ist unerlässlich sicherzustellen, dass nur autorisierte Entwickler mit gültigen API-Anmeldeinformationen auf die API zugreifen und sie nutzen können.
• Schließlich sollte die API-Nutzung so selbstbedienungsfähig wie möglich sein, um die Kosten für Kommunikation und Zusammenarbeit zu reduzieren.

Um diese Probleme zu lösen und die API-Nutzung zu optimieren, wurde das Konzept eines Developer Portals eingeführt.

Developer Portal

Ein Developer Portal ermöglicht es externen Entwicklern, APIs zu entdecken und darauf zuzugreifen, detaillierte Dokumentationen zu überprüfen, APIs zu testen und gültige API-Anmeldeinformationen zu erwerben. Es dient als Selbstbedienungsplattform für externe Entwickler, die es ihnen ermöglicht, effizienter auf APIs zuzugreifen und die Belastung der API-Produzenten zu verringern.

Das Developer Portal besteht typischerweise aus zwei Websites: der Verwaltungsseite und der Entwicklerseite. Die Verwaltungsseite wird von API-Produzenten (im Folgenden als Administratoren bezeichnet) verwendet, während die Entwicklerseite von API-Nutzern (im Folgenden als Entwickler bezeichnet) verwendet wird.

Die Verwaltungsseite des Developer Portals spielt eine entscheidende Rolle, um Administratoren zu ermöglichen, die API-Veröffentlichung und -Einstellung effektiv zu verwalten. Nur APIs, die veröffentlicht wurden, sind auf der Entwicklerseite sichtbar. Administratoren können auch Richtlinien wie QPS-Limits und Authentifizierungsanforderungen anwenden, um sicherzustellen, dass die APIs geschützt sind. Darüber hinaus können Administratoren Anfragen von der Entwicklerseite überprüfen, einschließlich Entwicklerkontoregistrierung und Abonnementanfragen für bestimmte APIs. Bestimmte Developer Portal-Produkte bieten sogar die Möglichkeit, dass Administratoren das Erscheinungsbild der Entwicklerseite anpassen können, z.B. durch das Ersetzen des Logos oder das Ändern des Slogans.

Die Entwicklerseite ist für API-Nutzer konzipiert. Hier können Entwickler alle von Administratoren veröffentlichten APIs anzeigen, einschließlich ihrer detaillierten Informationen, und API-Abonnements beantragen. Sie können Zugriffsanmeldeinformationen für die abonnierten APIs erstellen und lernen, wie sie integriert werden können, indem sie sich auf die API-Dokumentation beziehen.

Einige Developer Portals integrieren API-Aufrufanalysen, die die Anzahl der Aufrufe und die Latenz bestimmter APIs aus der Perspektive des Entwicklers auf der Verwaltungsseite anzeigen. Diese Daten können als Grundlage für Entscheidungen für zukünftige Iterationen und Optimierungen der API dienen und helfen, ihre Leistung zu verbessern.

Da sich das API-Ökosystem weiterentwickelt, erhält das Konzept der API-Monetarisierung zunehmend Aufmerksamkeit. Das Developer Portal ist zu einem wertvollen Werkzeug für die API-Monetarisierung geworden. Administratoren können mehrere Abonnementpläne für APIs erstellen und unterschiedliche Gebühren basierend auf variierenden Kontingenten oder der Anzahl der API-Aufrufe berechnen.

Das kommende API7 DevPortal

API7.ai ist bestrebt, unseren Benutzern unvergleichliche API-Management-Dienste zu bieten. Wir freuen uns, unser neuestes Angebot, das API7 DevPortal, vorzustellen, ein umfassendes Developer Portal-Produkt, das nahtlos in unsere Enterprise-Level API-Gateway-Lösung, API7 Enterprise, integriert ist, das auf Apache APISIX basiert.

Das API7 DevPortal ist darauf ausgelegt, die Bedürfnisse unserer Kunden zu erfüllen und bietet Funktionen wie API-Abonnement und Entwicklerregistrierungsgenehmigung. Mit unserem Developer Portal können Kunden mühelos ihre Gateway-proxy-APIs veröffentlichen und ihren Entwicklern detaillierte Informationen über die APIs auf der Entwicklerseite bereitstellen.

Darüber hinaus verstehen wir die Bedeutung der Rationalisierung von Arbeitsabläufen, um die Produktivität zu steigern und das Umsatzwachstum zu fördern. Daher wird das API7 DevPortal in Zukunft zwei bedeutende Iterationen durchlaufen.

• Erstens werden wir uns in die Genehmigungsworkflows unserer Kunden integrieren. Einige unserer Kunden haben eine einheitliche Genehmigungsplattform, um verschiedene Genehmigungsvorgänge zu verwalten. Wir streben an, dass Kunden das API7 DevPortal nutzen können, ohne ihre bestehenden Genehmigungsgewohnheiten zu ändern.

• Zweitens werden wir API-Monetarisierung unterstützen, um unseren Kunden zu helfen, Abonnementdienste auf verschiedenen Ebenen für Entwickler bereitzustellen und die Gebührenerhebung zu unterstützen. Wir werden das API7 DevPortal bald auf den Markt bringen.

Wenn Sie an diesem Produkt interessiert sind, kontaktieren Sie uns bitte hier.

Zusammenfassung

Developer Portals spielen eine entscheidende Rolle bei der Verwaltung der API-Nutzung, indem sie API-Produzenten ermöglichen, API-Integrationsprobleme effektiv zu lösen, ohne die Sicherheit zu beeinträchtigen, und die Monetarisierung zu erleichtern. In der heutigen API-getriebenen Welt ist es unerlässlich, die Implementierung eines Developer Portals in die API-Management-Strategie Ihres Teams in Betracht zu ziehen.