Warum die Erfahrung eines API-Entwicklers wichtig ist

Dies ist der zweite Beitrag einer zweiteiligen Reihe zum API Connectivity Manager:

• 5 Möglichkeiten zur Bekämpfung der API-Ausbreitung (und warum Sie sich darum kümmern sollten)
• Warum die Erfahrung eines API-Entwicklers wichtig ist – dieser Beitrag

APIs stehen im Mittelpunkt moderner Geschäftsprozesse. Während APIs in der Softwareentwicklung schon immer eine wichtige Rolle gespielt haben, führt die wachsende Nachfrage nach Datenintegration zu einer breiteren Nutzung von APIs in allen Geschäftsbereichen. APIs dienen jedoch nicht nur der Verbindung von Daten und Applications – sie sind auch von entscheidender Bedeutung für die Zusammenarbeit mit externen Geschäftspartnern, die Bereitstellung von Diensten für Kunden und die Erzielung von Umsätzen als eigenständige Produkte.

Entwickler spielen im Zentrum der API-Wirtschaft eine entscheidende Rolle. Sie sind für die Erstellung, Integration und Wartung von APIs verantwortlich und sind sowohl die Entwickler als auch die technischen Anwender von APIs. Ihre Erfahrung, allgemein als API-Entwicklererfahrung bezeichnet, ist einer der wichtigsten Faktoren für den Gesamterfolg einer API. In diesem Beitrag werden die wichtigsten Konzepte der API-Entwicklererfahrung untersucht und erläutert, was IT-Leiter bei der Planung der API-Erfahrung berücksichtigen müssen.

1. Welche Erfahrung haben API-Entwickler?
2. Warum ist die Erfahrung eines API-Entwicklers wichtig?
3. Wie schaffen Sie großartige API-Entwicklererlebnisse?

Was ist die API-Entwicklererfahrung?

Die API-Entwicklererfahrung beschreibt die allgemeinen Wahrnehmungen und Emotionen, die ein Entwickler bei der Interaktion mit einer API hat. Sie umfasst die Infrastruktur, Tools, Prozesse, den Support und andere Kontaktpunkte, die zu einer angenehmen und reibungslosen Erfahrung für Entwickler beitragen, die APIs in ihre Applications integrieren. Die API-Entwicklererfahrung ist eine Unterpraxis der allgemeinen Entwicklererfahrung.

Warum ist die Erfahrung eines API-Entwicklers wichtig?

Während die erste Generation technologischer Innovationen durch konsequenten Fokus auf das Benutzererlebnis geprägt war, wird die nächste Generation erfolgreicher Unternehmen mit einem Fokus auf das Entwicklererlebnis gewinnen.

Da die API-Wirtschaft weiter wächst, gewinnen Entwickler einen größeren Einfluss darauf, welche APIs übernommen werden. Wenn eine API schwer zu finden ist, keine ausreichende Dokumentation aufweist oder schlecht gewartet wird, werden Entwickler sie zugunsten einer einfacheren, schnelleren Alternative fallen lassen. Dies gilt für interne API-Programme gleichermaßen als auch für externe APIs für Partner und Kunden.

Bei externen APIs hat es konkrete geschäftliche Konsequenzen, wenn Entwickler Ihre API aufgeben. Sie verlieren nicht nur Umsatz mit direkten Kunden, sondern auch den Zugriff auf das breitere Ökosystem der von Ihren Kunden verwendeten Produkte und Lösungen. Sogar interne API-Programme sind von einer schlechten Entwicklererfahrung betroffen, beispielsweise eine längere Markteinführungszeit, eine geringere Entwicklerproduktivität und mehr Nacharbeit, was möglicherweise den Erfolg Ihres Unternehmens gefährdet.

Um in der entwicklerzentrierten Welt erfolgreich zu sein, benötigen Sie eine API-Strategie, die den Entwicklern in jeder Phase des API-Lebenszyklus die richtigen Tools und Ressourcen bietet. Der beste Weg hierfür besteht in der Schaffung einer durchdachten End-to-End -API-Erfahrung für Entwickler, die drei Arten der API-Nutzung umfasst:

• Bereitstellen und Verwalten von APIs
• Entdecken und Testen von APIs
• Überwachung und Sicherung von APIs

Wie schaffen Sie großartige API-Entwicklererlebnisse?

Um eine positive Erfahrung zu schaffen, müssen Sie verstehen, wie Entwickler Ihre API verwenden, was sie zur Erledigung ihrer Aufgaben benötigen und letztendlich, wie sie sich bei der Verwendung Ihrer API fühlen. Sobald Sie die Personas definiert haben, die mit Ihren APIs interagieren, können Sie mit der Planung der gesamten API-Erfahrung beginnen.

Bei der Gestaltung der API-Entwicklererfahrung müssen vier Grundsätze berücksichtigt werden:

1. Benutzer identifizieren – Wer interagiert mit der API?
2. Funktionalität definieren – Was macht die API?
3. Benutzerfreundlichkeit optimieren – Wie einfach ist die API zu verwenden?
4. Verbessern Sie das Erlebnis – Wie fühlt es sich an, die API zu verwenden?

Sehen wir uns jedes Prinzip an und was Sie bereitstellen müssen, um ein optimales API-Erlebnis für Entwickler zu schaffen.

Schritt 1: Benutzer identifizieren

Genauso 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 die Anliegen der Entwickler berücksichtigt werden. Entwickler sind mehr als der Endverbraucher – sie sind auch die Erbauer und Instandhalter der gesamten Infrastruktur.

Beim Entwerfen einer API-Entwicklererfahrung müssen drei primäre Personas berücksichtigt werden:

• API-Verbraucher – Entdecken, implementieren und verwalten Sie API-Integrationen für ihre Applications
• API-Besitzer – Planen, erstellen, dokumentieren, testen, implementieren und verwalten APIs für ihre Dienste
• Infrastrukturmanager – Legen Sie globale Richtlinien fest und überwachen Sie APIs auf Sicherheit und Compliance

Möglicherweise müssen Sie weitere Benutzer und Interessenvertreter berücksichtigen. Beispielsweise kann die Kategorie der API-Verbraucher Unterkategorien wie interne Entwickler, Partner und Kunden umfassen, jeweils mit unterschiedlichen Persönlichkeiten und Anforderungen.

Schritt 2: Funktionalität definieren

Die Funktion ist die Grundlage erfolgreicher APIs. Eine gute API ermöglicht Entwicklern die Integration wertvoller Daten oder Dienste, die schnellere Erledigung von Aufgaben und die Verkürzung des Gesamtzeitaufwands für die Entwicklung neuer Funktionen. Zu den wichtigsten Überlegungen gehören:

• Welchen Mehrwert bietet die API durch die Integration mit Daten oder Diensten?
• Wie gut löst die API das Problem durch die Reduzierung der Aufrufe und die Strukturierung der Daten?
• Wie zuverlässig ist die API in Bezug auf Verfügbarkeit, Zuverlässigkeit 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 geschrieben, bevor mit der Code-Entwicklung begonnen wird. Dabei liegt der Schwerpunkt auf der Struktur der API-Anfragen und den zurückgegebenen Daten. Dieser Schwerpunkt stellt sicher, dass die API stets den Wert und die Funktionalität liefert, die Entwickler benötigen.

Schritt 3: Optimieren Sie die Benutzerfreundlichkeit

Das dritte Prinzip, die Benutzerfreundlichkeit, befasst sich damit, wie Entwickler Ihre APIs verwenden und nicht damit, was sie damit tun können. Es deckt die Ressourcen rund um Ihre API ab, die Entdeckung, Lernen, Testen und Onboarding unterstützen. Ohne ein unterstützendes Ökosystem aus Infrastruktur, Tools und Dokumentation werden Entwickler Probleme bei der Verwendung Ihrer APIs haben. Zu den wichtigen Überlegungen gehören:

• Einfache Anmeldung mit integriertem Single Sign-On (SSO) und einfacher Verwaltung von API-Schlüsseln
• Klare und ausführliche Dokumentation mit aktuellen Referenzen und Codebeispielen
• Schnelle Einrichtungszeit mit der Erstellung einer grundlegenden API-Anfrage, die im Idealfall weniger als fünf Minuten dauert

Im „State of the API Report 2022“ von Postman gaben die Umfrageteilnehmer an, dass die Haupthindernisse für die Nutzung von APIs folgende sind:

• Fehlende Dokumentation (55 %)
• Probleme beim Entdecken von APIs (38 %)
• Fehlende grundlegende API-Kenntnisse (30 %)

Sie können diese Probleme überwinden, indem Sie zentrale Entwicklerportale mit ausführlicher Dokumentation, Codebeispielen und Tools zum Ausprobieren von APIs nutzen.

Schritt 4: Verbessern Sie das Erlebnis

Die Erfahrung des API-Entwicklers ist die Summe der Interaktionen zwischen dem API-Verbraucher und dem API-Eigentümer. Die Grundlage bildet die Funktionalität und Benutzerfreundlichkeit der API, es gibt jedoch noch weitere Interaktionen, die zum allgemeinen Vergnügen bei der Arbeit mit einer API beitragen. Dazu können gehören:

• Aktive Community verfügbar auf Kanälen wie Stack Overflow, Slack, Discord, Twitter usw.
• Zugänglicher Support mit zeitnahen Antworten der Entwicklungsteams
• Reibungslose Erfahrung bei der Interaktion mit der API, der Dokumentation und der Community

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

Die Erfahrung des API-Entwicklers ist wichtig

Der Schlüssel zu einer großartigen API-Entwicklererfahrung umfasst Ihre API sowie das Ökosystem aus Tools, Prozessen, Dokumentation und Support darum herum. Wenn alle Teile Ihres API-Ökosystems reibungslos funktionieren, werden Reibungsverluste und Komplexität reduziert, sodass sich die Entwickler auf die Erstellung von Applications konzentrieren können.

Die oben beschriebenen Schritte sind Teil eines kontinuierlichen Prozesses zum Entwerfen, Implementieren, Testen und Bewerten der API-Entwicklererfahrung. Wenn Sie sich auf jeden der Hauptschritte konzentrieren – Benutzer identifizieren, Funktionalität definieren, Benutzerfreundlichkeit optimieren und das Erlebnis verbessern – können Sie APIs erstellen, deren Verwendung Spaß macht und sogar Spaß macht.

Wie verbessert NGINX die API-Entwicklererfahrung?

API Connectivity Manager , Teil der F5 NGINX Management Suite , wurde mit der Erfahrung von API-Entwicklern im Mittelpunkt entwickelt. Mit API Connectivity Manager können Infrastrukturteams leistungsstarke API-Gateways und Entwicklerportale bereitstellen. Und Entwickler können APIs und Dokumentationen schnell veröffentlichen und verwalten oder APIs entdecken und in Applications integrieren.

Zu den Vorteilen des API Connectivity Managers gehören:

• Schnelles Onboarding – Integrieren Sie Ihren bevorzugten Identitätsanbieter, um die Autorisierung und Authentifizierung auf dem Entwicklerportal zu optimieren
• Einfache Dokumentation – Verwenden Sie die OpenAPI-Spezifikation , um automatisch Dokumentation für das Entwicklerportal zu generieren, wenn API-Besitzer 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 zu erlernen.
• Workflow-Automatisierung – Integrieren Sie die API-Veröffentlichung und -Verwaltung in Ihre CI/CD-Pipelines mithilfe einer vollständig deklarativen REST-API.

Erste Schritte

Starten Sie eine 30-tägige kostenlose Testversion der NGINX Management Suite , die API Connectivity Manager und Instance Manager umfasst.

Verwandte Ressourcen

• Blog: Verbinden, skalieren und sichern Sie Apps und APIs mit der F5 NGINX Management Suite
• Blog: 5 Möglichkeiten zur Bekämpfung der API-Ausbreitung (und warum Sie sich dafür interessieren sollten)
• Lösungsübersicht: NGINX Management Suite API-Konnektivitätsmanager