17
.
March
2023
·
3
Minuten Lesezeit

Developer Centric: API Design Lifecycle (Phase 1-2)

Eine gut designte API sollte den Erwartungen der Entwickler:innen an Qualität und Standards entsprechen: DX is the new UX! In den kommenden Wochen werden Lars Röwekamp und Arne Limburg Schritt für Schritt alle acht Phasen des API Design Lifecycle erklären.

Phase 1: Planung

APIs sind der Schlüssel zur Erschließung neuer digitaler Kanäle. Sie ermöglichen interne und externe Datenbereitstellung, erhöhen die Partnerbindung und generieren neue Geschäftsmodelle.

APIs schaffen Mehrwerte

Für das Unternehmen liefern APIs Datenzugriff und Agilität. Der Kunde kann die digitalen Mehrwerte vermarkten, Partner profitieren von der Generierung von B2B Synergien und das Marketing erhält Unterstützung von mobilen Initiativen.

Business Modell

Ein passende Business Modell spielt bei der Planung der API Strategie eine wichtige Rolle.

Direkte Bezahlung

Entwickler müssen für die Nutzung der API zahlen (Pay-per-use, Stufenmodell, Freemium).

Umsatzbeteiligung

Entwickler werden an den generierten Umsätzen beteiligt.

Indirekte Bezahlung

Entwickler zahlen nicht direkt für die Nutzung der API, generieren aber zusätzlichen Umsatz.

Freie Nutzung

Die Nutzung der API ist frei, Mehrwerte sind erweiterte Funktionalität sowie zusätzliche Nutzer und Daten.

API Design Lifecycle: Phase 1
API Design Lifecycle: Phase 1

Phase 2: Design

Eine API sollte der Erwartungshaltung – DX aka Developer Experience – des Entwicklers an Qualität und Standards entsprechen. Sie sollte einfach und intuitiv zu verstehen, zu nutzen und zu testen sein und dabei in sich konsistent.

Design first Strategie

Während beim Ansatz "Code First" zunächst damit begonnen wird, eine API zu implementieren, um dann (aus Sicht des API-Entwicklers) zu schauen, woraus die API bestehen muss, rückt bei der Design-First-Strategie der Konsument der API in den Mittelpunkt. In der Design-Phase wird zunächst aus seiner Sicht betrachtet, wie die API sinnvoll aufgebaut werden muss. Eng damit verbunden ist die Strategie "Documentation First". Dabei wird das Design noch vor der Coding-Phase strukturiert dokumentiert (z.B. über OpenAPI). Diese Dokumentation hat den Vorteil, dass sich daraus mehr oder weniger automatisch verschiedene nützliche Artefakte wie Mocks, Prototypen, Test-Suites, Visualisierungen, Client-SDKs, Server-side Stubs und Policies erzeugen lassen, noch bevor die eigentliche Implementierung beginnt.

Open API

Der OpenAPI Standard bietet eine optimale Grundlage für den API First Ansatz:

• Verbesserte Developer Experience

• Governance für API Design & Kollaboration

• Sicherstellung von Wiederverwendbarkeit

OpenAPI unterstützt weitreichendes Tooling zur Automatisierung und Generierung von Artefakten für alle Phasen des API Lifecycle. Übergreifende API Design Guides sollten von Anfang an beim Design berücksichtigt werden.

API Design Lifecycle: Phase 2

Sei gespannt: In den kommenden Wochen werden Lars Röwekamp und Arne Limburg Schritt für Schritt alle acht Phasen des API Design Lifecycle erläutern.

Phase 3: Integration

Phase 4: Rollout

Phase 5: Motivation

Phase 6: Monitoring

Phase 7: Analyse

Phase 8: Evolution

No items found.

Weitere Artikel aus unserem Blog