Warum die Developer Experience bei APIs wichtig ist

NGINX | 08. September 2022

Rajesh BavananthamDirektor für Produktmanagement | NGINX

Dies ist der zweite Beitrag einer zweiteiligen Serie über den API Connectivity Manager:

5 Wege zur Bekämpfung der API-Ausbreitung (und warum Sie das interessieren sollte)
Warum die API-Entwicklererfahrung wichtig ist – dieser Beitrag

APIs stehen im Mittelpunkt moderner Unternehmen. Obwohl APIs schon immer eine wichtige Rolle in der Softwareentwicklung gespielt haben, führt die wachsende Nachfrage nach Datenintegration dazu, dass APIs in allen Geschäftsbereichen zunehmend eingesetzt werden. Doch APIs verbinden nicht nur Daten und Anwendungen – sie sind auch entscheidend für die Zusammenarbeit mit externen Geschäftspartnern, die Bereitstellung von Dienstleistungen für Kunden und die Erzielung von Umsätzen als eigenständige Produkte.

Entwickler spielen im Zentrum der API-Wirtschaft eine entscheidende Rolle. Da sie für die Entwicklung, Integration und Wartung von APIs verantwortlich sind, sind sie sowohl deren Urheber als auch deren technische Anwender. Ihre Erfahrung, die gemeinhin als „API Developer Experience“ bezeichnet wird, ist einer der wichtigsten Faktoren für den Gesamterfolg einer API. Dieser Beitrag beleuchtet die zentralen Konzepte der API Developer Experience und zeigt auf, was IT-Führungskräfte bei der Gestaltung der API Experience berücksichtigen müssen.

Was versteht man unter API-Entwicklererfahrung?
Warum ist die API-Entwicklererfahrung wichtig?
Wie schafft man eine hervorragende Entwicklererfahrung mit APIs?

Was versteht man unter API Developer Experience?

API-Entwicklererfahrung beschreibt die Gesamtheit der Wahrnehmungen und Emotionen, die ein Entwickler bei der Interaktion mit einer API erlebt. Sie umfasst die Infrastruktur, Tools, Prozesse, Unterstützung und weitere Berührungspunkte, die Entwicklern eine angenehme und reibungslose Integration von APIs in ihre Anwendungen ermöglichen. Die API-Entwicklererfahrung ist ein Teilbereich der allgemeinen Entwicklererfahrung.

Warum ist die API-Entwicklererfahrung wichtig?

Wenn ein unermüdlicher Fokus auf die User Experience die erste Generation technologischer Innovationen vorangetrieben hat, dann wird die nächste Generation erfolgreicher Unternehmen durch ihren Fokus auf die Developer Experience überzeugen.

Mit dem weiteren Wachstum der API-Wirtschaft gewinnen Entwickler zunehmend Einfluss darauf, welche APIs eingesetzt werden. Wenn eine API schwer auffindbar ist, keine ausreichende Dokumentation bietet oder schlecht gepflegt wird, entscheiden sich Entwickler stattdessen für eine einfachere und schnellere Alternative. Dies gilt gleichermaßen für interne API-Programme wie für externe APIs für Partner und Kunden.

Bei externen APIs hat es spürbare geschäftliche Folgen, wenn Entwickler Ihre API nicht mehr nutzen. Sie verlieren nicht nur Umsätze mit direkten Kunden, sondern auch den Zugang zum umfassenderen Ökosystem der von Ihren Kunden genutzten Produkte und Lösungen. Selbst interne API-Programme leiden unter den Folgen einer unzureichenden Entwicklererfahrung, darunter eine längere Markteinführungszeit, eine geringere Entwicklerproduktivität und ein erhöhter Nacharbeitsaufwand, was den Erfolg Ihres Unternehmens gefährden kann.

Um in einer entwicklerzentrierten Welt erfolgreich zu sein, benötigen Sie eine API-Strategie, die Entwicklern in jeder Phase des API-Lebenszyklus die richtigen Tools und Ressourcen zur Verfügung stellt. Am besten gelingt dies durch eine durchdachte, durchgängige API-Erfahrung für Entwickler, die drei Arten der API-Nutzung umfasst:

APIs bereitstellen und verwalten
APIs entdecken und testen
APIs überwachen und absichern

Wie schaffen Sie eine hervorragende Developer Experience für APIs?

Für ein positives Erlebnis ist es entscheidend zu verstehen, wie Entwickler Ihre API nutzen, was sie benötigen, um ihre Aufgaben zu erledigen, und letztlich, wie sie sich bei der Nutzung Ihrer API fühlen. Sobald Sie die Personas definiert haben, die mit Ihren APIs interagieren werden, können Sie mit der Planung der gesamten API-Erfahrung beginnen.

Bei der Gestaltung der Entwicklererfahrung mit einer API sind vier Grundsätze zu berücksichtigen:

Benutzer identifizieren – Wer interagiert mit der API?
Funktionalität definieren – Was macht die API?
Benutzerfreundlichkeit optimieren – Wie einfach lässt sich die API verwenden?
Nutzungserlebnis verbessern – Wie fühlt es sich an, die API zu verwenden?

Sehen wir uns die einzelnen Prinzipien an und was Sie bereitstellen müssen, um Entwicklern eine optimale API-Erfahrung zu bieten.

Grafik mit den vier Prinzipien des API-Designs: Benutzer identifizieren, Funktionalität definieren, Benutzerfreundlichkeit optimieren und Nutzungserlebnis verbessern

Schritt 1: Benutzer identifizieren

So wie Sie Produkte für spezifische Kundenprobleme entwickeln, müssen Sie auch die API-Erfahrung in Ihrer gesamten Infrastruktur und Ihren Produkten so gestalten, dass sie den Anforderungen der Entwickler gerecht wird. Entwickler sind mehr als nur Endnutzer – sie sind auch für den Aufbau und die Wartung der gesamten Infrastruktur verantwortlich.

Bei der Gestaltung der Entwicklererfahrung für eine API sind drei zentrale Personas zu berücksichtigen:

API-Nutzer – API-Integrationen für ihre Anwendungen finden, implementieren und pflegen
API-Verantwortliche – APIs für ihre Dienste planen, entwickeln, dokumentieren, testen, bereitstellen und verwalten
Infrastrukturmanager – Legen globale Richtlinien fest und überwachen APIs im Hinblick auf Sicherheit und Compliance

Möglicherweise müssen Sie weitere Benutzer und Stakeholder berücksichtigen. Beispielsweise könnte die Kategorie der API-Nutzer Unterkategorien wie interne Entwickler, Partner und Kunden umfassen, die jeweils unterschiedliche Personas und Anforderungen haben.

Schritt 2: Funktionalität definieren

Funktionalität ist die Grundlage erfolgreicher APIs. Eine gute API ermöglicht es Entwicklern, wertvolle Daten oder Dienste zu integrieren, Aufgaben schneller zu erledigen und den Zeitaufwand für die Entwicklung neuer Funktionen insgesamt zu reduzieren. Zu den wichtigsten Aspekten gehören:

Welchen Mehrwert bietet die API durch die Integration von Daten oder Diensten?
Wie gut löst die API das Problem durch die Reduzierung von Aufrufen und die Strukturierung der Daten?
Wie zuverlässig ist die API in Bezug auf Verfügbarkeit, Ausfallsicherheit und Skalierbarkeit?

Die Funktionalität einer API ist eng mit dem API-First-Entwicklungsansatz verknüpft. Im Gegensatz zu „Code First“ wird bei „API First“ die API-Spezifikation erstellt, bevor die Codeentwicklung beginnt. Dabei liegt der Schwerpunkt auf der Struktur der API-Anfragen und den zurückgegebenen Daten. So wird sichergestellt, dass die API stets den Nutzen und die Funktionalität bietet, die Entwickler benötigen.

Schritt 3: Benutzerfreundlichkeit optimieren

Das dritte Prinzip, die Benutzerfreundlichkeit, befasst sich damit, wie Entwickler Ihre APIs nutzen, und nicht damit, was sie damit tun können. Es umfasst die Ressourcen rund um Ihre API, die das Auffinden, Erlernen, Testen und Onboarding unterstützen. Ohne ein unterstützendes Ökosystem aus Infrastruktur, Tools und Dokumentation werden Entwickler Schwierigkeiten haben, Ihre APIs zu nutzen. Zu den wichtigen Aspekten gehören:

Einfache Registrierung mit integriertem Single Sign-on (SSO) und unkomplizierter Verwaltung von API-Schlüsseln
Klare und umfassende Dokumentation mit aktuellen Referenzen und Codebeispielen
Schnelle Einrichtung – eine einfache API-Anfrage sollte sich idealerweise in weniger als fünf Minuten erstellen lassen

Im „2022 State of the API Report“ von Postman nannten die Befragten die folgenden größten Hindernisse bei der Nutzung von APIs:

Fehlende Dokumentation (55 %)
Schwierigkeiten beim Auffinden von APIs (38 %)
Fehlende grundlegende API-Kenntnisse (30 %)

Sie können diese Probleme mithilfe zentraler Entwicklerportale mit ausführlicher Dokumentation, Codebeispielen und Tools zum Ausprobieren von APIs bewältigen.

Schritt 4: Benutzererlebnis verbessern

Die API-Entwicklungserfahrung ergibt sich aus der Gesamtheit der Interaktionen zwischen API-Nutzern und API-Anbietern. Die Grundlage bilden die Funktionalität und Benutzerfreundlichkeit der API. Darüber hinaus gibt es weitere Interaktionen, die dazu beitragen, dass die Arbeit mit einer API insgesamt angenehm ist. Dazu können gehören:

Aktive Community auf Kanälen wie Stack Overflow, Slack, Discord, Twitter usw.
Gut erreichbarer Support mit zeitnahen Antworten der Entwicklungsteams
Reibungslose Nutzung bei der Interaktion mit der API, der Dokumentation und der Community

Entwickler, die gerne mit Ihren APIs arbeiten, empfehlen diese eher ihren Kollegen, entwickeln darauf aufbauend neue Funktionen und integrieren sie in ihre Apps.

Die Developer Experience bei APIs ist entscheidend

Der Schlüssel zu einer hervorragenden API-Entwicklererfahrung liegt sowohl in Ihrer API als auch im sie umgebenden Ökosystem aus Tools, Prozessen, Dokumentation und Support. Wenn alle Komponenten Ihres API-Ökosystems nahtlos zusammenspielen, reduzieren sie Reibungsverluste und Komplexität, sodass sich Entwickler auf die Entwicklung von Anwendungen konzentrieren können.

Die oben beschriebenen Schritte sind Teil eines kontinuierlichen Prozesses, bei dem die API-Entwicklungserfahrung konzipiert, implementiert, getestet und bewertet wird. Wenn Sie sich auf jeden der wichtigsten Schritte konzentrieren – Benutzer identifizieren, Funktionen definieren, Benutzerfreundlichkeit optimieren und die Erfahrung verbessern –, können Sie APIs entwickeln, deren Nutzung angenehm ist und sogar Spaß macht.

Wie verbessert NGINX die API-Entwicklererfahrung?

API Connectivity Manager, ein Bestandteil der F5 NGINX Management Suite, wurde mit besonderem Fokus auf die Benutzerfreundlichkeit für API-Entwickler konzipiert. Mit API Connectivity Manager können Infrastrukturteams leistungsstarke API-Gateways und Entwicklerportale bereitstellen. Entwickler wiederum können APIs und Dokumentationen schnell veröffentlichen und verwalten oder APIs finden und in Anwendungen integrieren.

Zu den Vorteilen von API Connectivity Manager gehören:

Schnelles Onboarding – Integrieren Sie Ihren bevorzugten Identitätsanbieter, um die Autorisierung und Authentifizierung im Entwicklerportal zu optimieren
Einfache Dokumentation – Verwenden Sie die OpenAPI Specification, um automatisch Dokumentation für das Entwicklerportal zu erstellen, wenn API-Verantwortliche APIs im API-Gateway veröffentlichen
Interaktives Lernen – Ermöglichen Sie Entwicklern, Ihre APIs mit einem integrierten API-Explorer im Entwicklerportal zu entdecken, zu testen und kennenzulernen
Workflow-Automatisierung – Integrieren Sie die Veröffentlichung und Verwaltung von APIs mithilfe einer vollständig deklarativen REST-API in Ihre CI/CD-Pipelines