Bevor Sie etwas bauen, sollten Sie von Anfang an den Wert, die Benutzer und die Geschäftsziele Ihrer API definieren.
Viele Unternehmen betrachten APIs als technische Projekte und nicht als Produkte. Das Ergebnis? Verwirrte Kunden, schlechte Akzeptanz und verschwendeter Aufwand.
Diese Station hilft Ihnen, den Zweck Ihrer API, die Zielgruppe und die Erfolgskriterien zu definieren, damit Teams APIs bereitstellen können, die echte Probleme lösen.
Stellen Sie sicher, dass Ihre API auffindbar, verständlich und nutzbar ist - vor und nach der Einführung.
Großartige APIs funktionieren nicht nur - sie fühlen sich auch intuitiv an. Ganz gleich, ob Ihr Kunde ein interner Entwickler, ein externer Partner oder ein KI-Agent ist, seine Erfahrung entscheidet über die Akzeptanz.
Ohne einen klaren Erlebnisplan:
- Großartige APIs bleiben ungenutzt
- Teams verschwenden Zeit damit, zu raten, wie sie Ihre API verwenden sollen
- Feedbackschleifen sind unterbrochen oder fehlen.
Diese Station hilft Ihnen, Ihre API mit den Augen ihrer Nutzer zu sehen.
Gewährleisten Sie Skalierbarkeit, Wiederverwendung und Governance für Ihre API- und Plattformkomponenten.
Wenn APIs teamübergreifend skaliert werden, muss Ihre Plattform Governance und Wiederverwendung ermöglichen, ohne die Geschwindigkeit zu beeinträchtigen. Diese Station zeigt, wie man APIs für Langlebigkeit, Sicherheit und Effizienz entwickelt.
Erstellen Sie API-Designs, die konsistent, wiederverwendbar und auf Geschäftszielen und gemeinsamen Standards basieren.
Beim Entwurf von APIs geht es nicht nur um die Benennung von Endpunkten. Gutes Design stellt sicher, dass APIs benutzerfreundlich, konsistent und auf Geschäfts- und technische Ziele ausgerichtet sind. Schlecht gestaltete APIs führen zu enger Kopplung, geringer Wiederverwendung und kostspieligen Nacharbeiten in den Teams.
Erstellen, Testen und Freigeben von APIs unter Verwendung moderner Bereitstellungspipelines und bewährter technischer Verfahren.
Selbst die besten API-Designs scheitern, wenn die Bereitstellung uneinheitlich ist. Diese Station stellt sicher, dass Ihre APIs qualitativ hochwertig erstellt, gründlich getestet und zuverlässig bereitgestellt werden - für schnellere Iterationen und mehr Vertrauen.
Stellen Sie sicher, dass APIs vor der Veröffentlichung und Bereitstellung den geschäftlichen, gestalterischen und betrieblichen Standards entsprechen.
APIs sind langlebige Produkte und müssen den Erwartungen hinsichtlich Qualität, Konsistenz und Compliance entsprechen. Das Audit verbindet Designentscheidungen, Implementierung und Betriebsbereitschaft mit definierten Standards und reduziert so Risiken vor der Bereitstellung.
Stellen Sie APIs mit der richtigen Dokumentation und den richtigen Prozessen sicher und klar für die richtige Zielgruppe bereit.
Bei der Veröffentlichung geht es nicht nur um die Bereitstellung, sondern auch um die Auffindbarkeit, den Zugang und die Unterstützung. Wenn APIs nicht korrekt veröffentlicht werden, können sie nicht verwendet, wiederverwendet oder effektiv gesichert werden.
Nutzen Sie Messgrößen und Feedback, um die API-Leistung zu verfolgen und kontinuierliche Verbesserungen voranzutreiben.
Die API-Bereitstellung endet nicht mit dem Start. Ohne Überwachung können Teams weder die Akzeptanz noch die Leistung oder den ROI verbessern. Diese Station stellt sicher, dass APIs nützlich und sicher bleiben und sich mit den Geschäftsanforderungen weiterentwickeln.
Publish this cycle
Export the page-specific template after reviewing the entity summary and supporting details above.
Confluence-Export
Publikationsvorlagen
Use Markdown for repositories and static sites, or Confluence-wiki markup for compatible Confluence pages.
Markdown
# API-Produktisierungszyklus question template
Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
## 1. API-Produktstrategie
Bevor Sie etwas bauen, sollten Sie von Anfang an den Wert, die Benutzer und die Geschäftsziele Ihrer API definieren.
### Canvas questions
#### Customer Journey Canvas
Welche Customer Journey oder Partner Journey erzeugt den Bedarf für eine Capability oder Schnittstelle?
- **Persona**: Wer ist der typische Kunde oder Nutzer, der diese Reise erlebt?
- **Kunde erkennt Bedarf**: Wie erkennt der Kunde oder Nutzer ein Bedürfnis oder Problem?
- **Kundenbedarf wird erfüllt**: Wie wird der Bedarf des Kunden oder Nutzers letztlich erfüllt?
- **Customer Journey Schritte**: Welche Schritte durchläuft der Kunde bei der Reise?
- **Probleme**: Welche Probleme oder Pain Points erlebt der Kunde oder Nutzer?
- **Nutzen**: Welchen Gewinn oder Nutzen hat der Kunde?
- **Inputs & Outputs**: Was sind die Inputs und Outputs bei jedem Schritt?
- **Interaktions- und Verarbeitungsregeln**: Wie lauten die Interaktions- und Verarbeitungsregeln bei jedem Schritt?
#### Domain Canvas
Welche wesentlichen Entitäten, Begriffe und Fachregeln muss die Capability oder Schnittstelle respektieren?
- **Ausgewählte Customer Journey Schritte**: Welche Customer Journey Schritte sind für diese Domäne relevant?
- **Grundlegende Entitäten & geschäftliche Bedeutung**: Welches sind die wesentlichen Entitäten und ihre Bedeutung für das Geschäft?
- **Attribute & geschäftliche Wichtigkeit**: Welches sind die Schlüsselattribute der einzelnen Entitäten und ihre geschäftliche Wichtigkeit?
- **Beziehungen zwischen Entitäten**: Welche Beziehungen bestehen zwischen den Entitäten?
- **Fachregeln, Compliance und Integrität**: Welche Fachregeln sowie Compliance- und Integritätsanforderungen beziehen sich auf die Entitäten?
- **Überlegungen zu Sicherheit und Datenschutz**: Welche Überlegungen zur Sicherheit und zum Datenschutz gibt es im Zusammenhang mit den Entitäten?
#### API Value Proposition Canvas
Wie hängt die Customer Journey mit APIs zusammen? Welche Pain Points und Nutzen von Endnutzern und API-Nutzern müssen adressiert werden?
- **Aufgaben**: Was möchten Kunden oder Endnutzer erreichen?
- **Nutzenstiftende Funktionen**: Welche Funktionen helfen Endnutzern und API-Nutzern, den gewünschten Nutzen zu erreichen?
- **Funktionen zur Reduktion von Pain Points**: Welche Funktionen helfen Endnutzern und API-Nutzern, Pain Points zu reduzieren?
- **API-Produkte**: Welche API-Produkte und -Features eigenen sich für diese Aufgaben, Probleme und Bedürfnisse?
#### API Business Model Canvas
Wie praktikabel und wiederverwendbar wird diese API sein? Haben wir einen Business Case aus Kosten-Nutzen-Sicht?
- **Wertversprechen der API**: Beginnen Sie mit einem Haftzettel, auf dem Sie die API oder die API-Familie benennen, und erfassen Sie dann, welchen Nutzen die API den API-Nutzern bietet.
- **API-Nutzersegmente**: Wer sind die Zielgruppen für die API?
- **Developer Relations**: Wie erreicht und unterstützt der API-Anbieter die API-Nutzer?
- **Kanäle**: Über welche Mechanismen interagieren API-Nutzer mit der API?
- **Schlüsselressourcen**: Welche strategischen Ressourcen muss der API-Anbieter beschaffen oder aufbauen?
- **Schlüsselaktivitäten**: Welche wichtigsten Aktivitäten muss der API-Anbieter ausführen, damit die API erfolgreich betrieben werden kann?
- **Schlüsselpartner**: Wer sind die wichtigsten beteiligten Stakeholder?
- **Vorteile**: Was sind die wesentlichen Vorteile oder Einnahmequellen, die durch die API generiert werden?
- **Kosten**: Welche wesentlichen Kosten entstehen durch Aufbau, Bereitstellung und Betrieb der API?
## 2. API Consumer Experience
Stellen Sie sicher, dass Ihre API auffindbar, verständlich und nutzbar ist - vor und nach der Einführung.
### Canvas questions
#### API Value Proposition Canvas
Wie hängt die Customer Journey mit APIs zusammen? Welche Pain Points und Nutzen von Endnutzern und API-Nutzern müssen adressiert werden?
- **Aufgaben**: Was möchten Kunden oder Endnutzer erreichen?
- **Nutzenstiftende Funktionen**: Welche Funktionen helfen Endnutzern und API-Nutzern, den gewünschten Nutzen zu erreichen?
- **Funktionen zur Reduktion von Pain Points**: Welche Funktionen helfen Endnutzern und API-Nutzern, Pain Points zu reduzieren?
- **API-Produkte**: Welche API-Produkte und -Features eigenen sich für diese Aufgaben, Probleme und Bedürfnisse?
#### Customer Journey Canvas
Welche Customer Journey oder Partner Journey erzeugt den Bedarf für eine Capability oder Schnittstelle?
- **Persona**: Wer ist der typische Kunde oder Nutzer, der diese Reise erlebt?
- **Kunde erkennt Bedarf**: Wie erkennt der Kunde oder Nutzer ein Bedürfnis oder Problem?
- **Kundenbedarf wird erfüllt**: Wie wird der Bedarf des Kunden oder Nutzers letztlich erfüllt?
- **Customer Journey Schritte**: Welche Schritte durchläuft der Kunde bei der Reise?
- **Probleme**: Welche Probleme oder Pain Points erlebt der Kunde oder Nutzer?
- **Nutzen**: Welchen Gewinn oder Nutzen hat der Kunde?
- **Inputs & Outputs**: Was sind die Inputs und Outputs bei jedem Schritt?
- **Interaktions- und Verarbeitungsregeln**: Wie lauten die Interaktions- und Verarbeitungsregeln bei jedem Schritt?
### Other related resources
- **Bewährte Praktiken beim API-Onboarding**: Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.
## 3. API-Plattformarchitektur
Gewährleisten Sie Skalierbarkeit, Wiederverwendung und Governance für Ihre API- und Plattformkomponenten.
### Canvas questions
#### Business Impact Canvas
Welche geschäftlichen Auswirkungen kann ein Ausfall oder Fehlverhalten der Capability oder Schnittstelle haben?
- **Risiken der Verfügbarkeit**: Was sind die potenziellen Risiken für die API-Verfügbarkeit?
- **Reduzierung von Risiken der Verfügbarkeit**: Wie lassen sich Verfügbarkeitsrisiken reduzieren?
- **Sicherheitsrisiken**: Welche potenziellen Sicherheitsrisiken sind mit der API assoziiert?
- **Reduktion der Sicherheitsrisiken**: Wie lassen sich Sicherheitsrisiken reduzieren?
- **Datenrisiken**: Welche potenziellen Risiken bestehen für die Datenintegrität oder -Vertraulichkeit?
- **Reduktion der Datenrisiken**: Wie lassen sich Datenrisiken reduzieren?
#### Location Canvas
Welche geopolitischen, regulatorischen, Netzwerk- und Vertrauensgrenzen betreffen diese Capability oder Schnittstelle?
- **Standort-/Vertrauensgruppen**: Welche geopolitischen, regulatorischen, netzwerkbezogenen oder vertrauensbezogenen Gruppen sind relevant?
- **Gruppenmerkmale**: Was sind die Merkmale dieser Gruppen, wie z. B. Standort, Vertrauensstufe oder Netzwerkexposition?
- **Relevante Standorte / Zonen**: Was sind die relevanten Standorte, Zonen oder Umgebungen innerhalb jeder Gruppe?
- **Standort-/Zonenmerkmale**: Was sind die Merkmale dieser Standorte oder Zonen, wie z. B. Eigentumsverhältnisse, Region oder Exposition?
- **Netzwerk- / Regulierungsentfernungen**: Welche Latenz-, Vertrauens-, Regulierungs- oder Konnektivitätsentfernungen bestehen zwischen den Standorten?
- **Entfernungsmerkmale**: Was sind die Merkmale dieser Entfernungen, wie z. B. Latenzempfindlichkeit, Aufenthaltsbeschränkungen oder Vertrauensgrenzen?
- **Konnektivitätsendpunkte**: Welche Konnektivitätsendpunkte oder Schnittstellen sind mit den Standorten verbunden?
- **Endpunktzugriffseigenschaften**: Welche Eigenschaften weisen diese Endpunkte auf, wie z. B. Sichtbarkeit, Protokoll, Sicherheit oder Zugriffsbeschränkungen?
#### Capacity Canvas
Welche Kapazität ist erforderlich, um die Nutzung der Capability oder Schnittstelle zu unterstützen?
- **Aktuelles Geschäftsvolumen**: Wie hoch sind das aktuelle Geschäftsvolumen und die Transaktionsraten?
- **Zukünftige Konsumtrends**: Was sind die erwarteten künftigen Konsumtrends?
- **Spitzenlast- und Verfügbarkeitsanforderungen**: Was sind die Spitzenlast- und Verfügbarkeitsanforderungen?
- **Caching-Strategien**: Welche Caching-Strategien können zur Performanceoptimierung eingesetzt werden?
- **Strategien zur Ratenbegrenzung**: Welche Strategien zur Ratenbegrenzung können genutzt werden, um die Nutzung zu steuern?
- **Strategien zur Skalierung**: Welche Strategien zur Skalierung können eingesetzt werden, um das Wachstum zu unterstützen?
### Other related resources
- **API-Metriken und -Analysen**: Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.
## 4. API-Design
Erstellen Sie API-Designs, die konsistent, wiederverwendbar und auf Geschäftszielen und gemeinsamen Standards basieren.
### Canvas questions
#### Domain Canvas
Welche wesentlichen Entitäten, Begriffe und Fachregeln muss die Capability oder Schnittstelle respektieren?
- **Ausgewählte Customer Journey Schritte**: Welche Customer Journey Schritte sind für diese Domäne relevant?
- **Grundlegende Entitäten & geschäftliche Bedeutung**: Welches sind die wesentlichen Entitäten und ihre Bedeutung für das Geschäft?
- **Attribute & geschäftliche Wichtigkeit**: Welches sind die Schlüsselattribute der einzelnen Entitäten und ihre geschäftliche Wichtigkeit?
- **Beziehungen zwischen Entitäten**: Welche Beziehungen bestehen zwischen den Entitäten?
- **Fachregeln, Compliance und Integrität**: Welche Fachregeln sowie Compliance- und Integritätsanforderungen beziehen sich auf die Entitäten?
- **Überlegungen zu Sicherheit und Datenschutz**: Welche Überlegungen zur Sicherheit und zum Datenschutz gibt es im Zusammenhang mit den Entitäten?
#### Interaction Canvas
Welche Arten von Interaktionen muss diese Capability oder Schnittstelle unterstützen, bevor ein konkretes Protokolldesign gewählt wird?
- **CRUD Interaktionen**: Sind hier Interaktionen im CRUD-Stil erforderlich?
- **CRUD Input- & Output-Modelle**: Was sind die Eingabe- und Ausgabemodelle für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
- **CRUD Verarbeitung & Validierung**: Was sind die Verarbeitungs- und Validierungsregeln für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
- **Abfragegesteuerte Interaktionen**: Welche Lese- oder Abfrageinteraktionen sind erforderlich, um Nutzerfragen zu beantworten?
- **Abfragegesteuerte Input- & Output-Modelle**: Was sind die Eingabe- und Ausgabemodelle für die abfragegesteuerten Interaktionen?
- **Abfragegesteuerte Verarbeitung & Validierung**: Was sind die Verarbeitungs- und Validierungsregeln für die abfragegesteuerten Interaktionen?
- **Befehlsgesteuerte Interaktionen**: Welche Befehle zur Zustandsänderung sind gegebenenfalls erforderlich?
- **Befehlsgesteuerte Input- & Output-Modelle**: Was sind die Eingabe- und Ausgabemodelle für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
- **Befehlsgesteuerte Verarbeitung & Validierung**: Was sind die Verarbeitungs- und Validierungsregeln für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
- **Eventgesteuerte Interaktionen**: Welche Ereignisse müssen gegebenenfalls veröffentlicht oder verarbeitet werden?
- **Eventgesteuerte Input- & Output-Modelle**: Was sind die Eingabe- und Ausgabemodelle für die ereignisgesteuerten Interaktionen, falls dieser Stil erforderlich ist?
- **Eventgesteuerte Verarbeitung & Validierung**: Was sind die Verarbeitungs- und Validierungsregeln für die ereignisgesteuerten Interaktionen, falls dieser Stil benötigt wird?
#### REST Canvas
Wie kann die API nach RESTful-Prinzipien gestaltet werden?
- **API-Ressourcen**: Was sind die Schlüsselressourcen, die von der API bereitgestellt werden?
- **API-Ressourcenmodell**: Wie sieht die Struktur des API-Ressourcenmodells aus?
- **HTTP-Methoden der API**: Welche HTTP-Methoden werden für die Interaktion mit den API-Ressourcen verwendet?
- **HTTP-Methoden-Beispiel**: Geben Sie für jede HTTP-Methode ein Beispiel für eine API-Anfrage und -Antwort an.
#### Event Canvas
Welche Ereignisse sind für die Capability oder Schnittstelle relevant und wie werden sie verarbeitet?
- **Nutzeraufgabe / Auslöser**: Welche Nutzeraktion oder welches Systemereignis löst diese Ereignisoperation aus?
- **Input / Event-Payload**: Welche Daten sind in der eingehenden Event-Payload enthalten? Geben Sie die Schlüsselattribute an.
- **Verarbeitung / Logik**: Beschreiben Sie die Verarbeitungslogik der Backend-Systeme, einschließlich Validierungen, Transformationen oder Routing-Entscheidungen.
- **Output / Event-Ergebnis**: Welches Event oder welche Bestätigungsmeldung wird erzeugt? Geben Sie die Attribute des Output-Payloads an.
#### GraphQL Canvas
Wie kann die API nach GraphQL-Prinzipien gestaltet werden?
- **API-Name**: Wie lautet der Name der GraphQL-API oder des Endpunkts?
- **Ziele der API-Nutzer**: Welche Probleme versuchen API-Nutzer zu lösen? Welche Daten benötigen sie?
- **Schlüsseltypen**: Welche zentralen Typen werden bereitgestellt (z. B. Nutzer, Bestellung, Produkt)?
- **Beziehungen**: Wie stehen die Typen in verschachtelten Abfragen zueinander?
- **Abfragen**: Welche typischen Abfragen sollten unterstützt werden?
- **Mutationen**: Welche Operationen verändern Daten (z.B. erstellen, aktualisieren, löschen)?
- **Subscriptions**: Gibt es Echtzeit-Updates oder Ereignisse, die Nutzer abonnieren können?
- **Autorisierungsregeln**: Wer darf auf welche Felder oder Typen zugreifen?
- **Einschränkungen für Nutzer**: Gibt es Paginierungs-, Filter- oder Ratenbegrenzungen?
- **Notizen / Offene Fragen**: Gibt es noch offene Entscheidungen oder Integrationsüberlegungen?
### Other related resources
- **API Design Prinzipien**: Ein prägnanter Leitfaden zu API-Benutzerfreundlichkeit, Auffindbarkeit und Konsistenz, der auf gemeinsamen Designregeln und echten Kundenbedürfnissen basiert.
- **Vertrag Erstes Design**: Ein Leitfaden, der für API-first-Ansätze plädiert, bei denen formale Verträge (z. B. OpenAPI) verwendet werden, um die Beteiligten vor der Entwicklung aufeinander abzustimmen.
## 5. API-Bereitstellung
Erstellen, Testen und Freigeben von APIs unter Verwendung moderner Bereitstellungspipelines und bewährter technischer Verfahren.
### Station questions
- Verwenden Sie Best Practices für die API-Entwicklung als Leitfaden für die Implementierung des validierten Schnittstellenvertrags mit etablierten Frameworks und Bibliotheken, um sicherzustellen, dass das Ergebnis wiederverwendbar und wartbar ist.
- Erstellen Sie die API-Implementierung auf Basis des validierten Schnittstellenvertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.
- Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.
- Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.
- Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.
- Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass die API die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.
- Bereitstellung von Frameworks, Bibliotheken und Standards für die API-Implementierung. Implementierung von CI/CD-Pipelines, Qualitätssicherungs-Frameworks und Tools zur Automatisierung der Bereitstellung.
- Selbst die besten API-Designs scheitern, wenn die Bereitstellung uneinheitlich ist. Diese Station stellt sicher, dass Ihre APIs qualitativ hochwertig erstellt, gründlich getestet und zuverlässig bereitgestellt werden - für schnellere Iterationen und mehr Vertrauen.
### Other related resources
- **Bewährte Praktiken der API-Entwicklung**: Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.
- **Bewährte Praktiken für API-Tests**: Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.
- **APIOps CI/CD für APIs**: Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.
- **Bewährte Praktiken für die API-Sicherheit**: Eine Reihe praktikabler Kontrollen zur Sicherung von APIs, einschließlich Authentifizierung, Autorisierung, Verschlüsselung, Ratenbegrenzung und Konformitätsprüfungen auf Pipeline-Ebene.
## 6. API-Audit
Stellen Sie sicher, dass APIs vor der Veröffentlichung und Bereitstellung den geschäftlichen, gestalterischen und betrieblichen Standards entsprechen.
### Station questions
- Führen Sie Audits durch, um sicherzustellen, dass APIs vor der Veröffentlichung organisatorische, technische und rechtliche Standards erfüllen.
- Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.
- Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.
- Richten Sie einen konsistenten Audit-Prozess ein, der die API-Bereitschaft über alle Lebenszyklusphasen hinweg anhand definierter Kriterien, Nachweise und Standards bewertet. Stellen Sie sicher, dass Lücken frühzeitig erkannt und vor der Veröffentlichung behoben werden.
- APIs sind langlebige Produkte und müssen den Erwartungen hinsichtlich Qualität, Konsistenz und Compliance entsprechen. Das Audit verbindet Designentscheidungen, Implementierung und Betriebsbereitschaft mit definierten Standards und reduziert so Risiken vor der Bereitstellung.
### Other related resources
- **API Audit Checkliste**: Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.
- **Bewährte Praktiken zur API-Einhaltung**: Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.
## 7. API-Veröffentlichung
Stellen Sie APIs mit der richtigen Dokumentation und den richtigen Prozessen sicher und klar für die richtige Zielgruppe bereit.
### Station questions
- Veröffentlichen Sie APIs in den entsprechenden Gateways und Umgebungen, um die Wiederverwendbarkeit für mehrere Nutzer zu unterstützen.
- Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.
- Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.
- Ermöglichung der Veröffentlichung von APIs in der jeweiligen Umgebung mit klaren Registrierungs- und Zugriffsmechanismen (z. B. API-Schlüssel, OAuth, Abonnementpläne) je nach den Nutzersegmenten und den Sicherheits- und Compliance-Anforderungen.
- Bei der Veröffentlichung geht es nicht nur um die Bereitstellung, sondern auch um die Auffindbarkeit, den Zugang und die Unterstützung. Wenn APIs nicht korrekt veröffentlicht werden, können sie nicht verwendet, wiederverwendet oder effektiv gesichert werden.
### Other related resources
- **APIOps CI/CD für APIs**: Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.
- **Bewährte Praktiken beim API-Onboarding**: Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.
- **API Audit Checkliste**: Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.
## 8. API-Monitoring & Verbesserung
Nutzen Sie Messgrößen und Feedback, um die API-Leistung zu verfolgen und kontinuierliche Verbesserungen voranzutreiben.
### Station questions
- Überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Akzeptanzmetriken (z. B. NPS).
- Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.
- Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.
- Einrichtung von Analyserahmen zur Verfolgung von Leistung und Engagement. Entwickeln Sie Feedbackschleifen, Analysetools und Engagementstrategien für APIs.
- Die API-Bereitstellung endet nicht mit dem Start. Ohne Überwachung können Teams weder die Akzeptanz noch die Leistung oder den ROI verbessern. Diese Station stellt sicher, dass APIs nützlich und sicher bleiben und sich mit den Geschäftsanforderungen weiterentwickeln.
### Other related resources
- **API-Metriken und -Analysen**: Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.
- **Strategien für das Engagement der API-Gemeinschaft**: Ein Leitfaden für die Förderung der API-Annahme durch die Pflege von Gemeinschaften durch Inhalte, Support-Kanäle, Feedback-Schleifen und Strategien für soziales Engagement.
Confluence-wiki
h1. API-Produktisierungszyklus question template
Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
h2. 1. API-Produktstrategie
Bevor Sie etwas bauen, sollten Sie von Anfang an den Wert, die Benutzer und die Geschäftsziele Ihrer API definieren.
h3. Canvas questions
#### Customer Journey Canvas
Welche Customer Journey oder Partner Journey erzeugt den Bedarf für eine Capability oder Schnittstelle?
* *Persona*: Wer ist der typische Kunde oder Nutzer, der diese Reise erlebt?
* *Kunde erkennt Bedarf*: Wie erkennt der Kunde oder Nutzer ein Bedürfnis oder Problem?
* *Kundenbedarf wird erfüllt*: Wie wird der Bedarf des Kunden oder Nutzers letztlich erfüllt?
* *Customer Journey Schritte*: Welche Schritte durchläuft der Kunde bei der Reise?
* *Probleme*: Welche Probleme oder Pain Points erlebt der Kunde oder Nutzer?
* *Nutzen*: Welchen Gewinn oder Nutzen hat der Kunde?
* *Inputs & Outputs*: Was sind die Inputs und Outputs bei jedem Schritt?
* *Interaktions- und Verarbeitungsregeln*: Wie lauten die Interaktions- und Verarbeitungsregeln bei jedem Schritt?
#### Domain Canvas
Welche wesentlichen Entitäten, Begriffe und Fachregeln muss die Capability oder Schnittstelle respektieren?
* *Ausgewählte Customer Journey Schritte*: Welche Customer Journey Schritte sind für diese Domäne relevant?
* *Grundlegende Entitäten & geschäftliche Bedeutung*: Welches sind die wesentlichen Entitäten und ihre Bedeutung für das Geschäft?
* *Attribute & geschäftliche Wichtigkeit*: Welches sind die Schlüsselattribute der einzelnen Entitäten und ihre geschäftliche Wichtigkeit?
* *Beziehungen zwischen Entitäten*: Welche Beziehungen bestehen zwischen den Entitäten?
* *Fachregeln, Compliance und Integrität*: Welche Fachregeln sowie Compliance- und Integritätsanforderungen beziehen sich auf die Entitäten?
* *Überlegungen zu Sicherheit und Datenschutz*: Welche Überlegungen zur Sicherheit und zum Datenschutz gibt es im Zusammenhang mit den Entitäten?
#### API Value Proposition Canvas
Wie hängt die Customer Journey mit APIs zusammen? Welche Pain Points und Nutzen von Endnutzern und API-Nutzern müssen adressiert werden?
* *Aufgaben*: Was möchten Kunden oder Endnutzer erreichen?
* *Nutzenstiftende Funktionen*: Welche Funktionen helfen Endnutzern und API-Nutzern, den gewünschten Nutzen zu erreichen?
* *Funktionen zur Reduktion von Pain Points*: Welche Funktionen helfen Endnutzern und API-Nutzern, Pain Points zu reduzieren?
* *API-Produkte*: Welche API-Produkte und -Features eigenen sich für diese Aufgaben, Probleme und Bedürfnisse?
#### API Business Model Canvas
Wie praktikabel und wiederverwendbar wird diese API sein? Haben wir einen Business Case aus Kosten-Nutzen-Sicht?
* *Wertversprechen der API*: Beginnen Sie mit einem Haftzettel, auf dem Sie die API oder die API-Familie benennen, und erfassen Sie dann, welchen Nutzen die API den API-Nutzern bietet.
* *API-Nutzersegmente*: Wer sind die Zielgruppen für die API?
* *Developer Relations*: Wie erreicht und unterstützt der API-Anbieter die API-Nutzer?
* *Kanäle*: Über welche Mechanismen interagieren API-Nutzer mit der API?
* *Schlüsselressourcen*: Welche strategischen Ressourcen muss der API-Anbieter beschaffen oder aufbauen?
* *Schlüsselaktivitäten*: Welche wichtigsten Aktivitäten muss der API-Anbieter ausführen, damit die API erfolgreich betrieben werden kann?
* *Schlüsselpartner*: Wer sind die wichtigsten beteiligten Stakeholder?
* *Vorteile*: Was sind die wesentlichen Vorteile oder Einnahmequellen, die durch die API generiert werden?
* *Kosten*: Welche wesentlichen Kosten entstehen durch Aufbau, Bereitstellung und Betrieb der API?
h2. 2. API Consumer Experience
Stellen Sie sicher, dass Ihre API auffindbar, verständlich und nutzbar ist - vor und nach der Einführung.
h3. Canvas questions
#### API Value Proposition Canvas
Wie hängt die Customer Journey mit APIs zusammen? Welche Pain Points und Nutzen von Endnutzern und API-Nutzern müssen adressiert werden?
* *Aufgaben*: Was möchten Kunden oder Endnutzer erreichen?
* *Nutzenstiftende Funktionen*: Welche Funktionen helfen Endnutzern und API-Nutzern, den gewünschten Nutzen zu erreichen?
* *Funktionen zur Reduktion von Pain Points*: Welche Funktionen helfen Endnutzern und API-Nutzern, Pain Points zu reduzieren?
* *API-Produkte*: Welche API-Produkte und -Features eigenen sich für diese Aufgaben, Probleme und Bedürfnisse?
#### Customer Journey Canvas
Welche Customer Journey oder Partner Journey erzeugt den Bedarf für eine Capability oder Schnittstelle?
* *Persona*: Wer ist der typische Kunde oder Nutzer, der diese Reise erlebt?
* *Kunde erkennt Bedarf*: Wie erkennt der Kunde oder Nutzer ein Bedürfnis oder Problem?
* *Kundenbedarf wird erfüllt*: Wie wird der Bedarf des Kunden oder Nutzers letztlich erfüllt?
* *Customer Journey Schritte*: Welche Schritte durchläuft der Kunde bei der Reise?
* *Probleme*: Welche Probleme oder Pain Points erlebt der Kunde oder Nutzer?
* *Nutzen*: Welchen Gewinn oder Nutzen hat der Kunde?
* *Inputs & Outputs*: Was sind die Inputs und Outputs bei jedem Schritt?
* *Interaktions- und Verarbeitungsregeln*: Wie lauten die Interaktions- und Verarbeitungsregeln bei jedem Schritt?
h3. Other related resources
* *Bewährte Praktiken beim API-Onboarding*: Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.
h2. 3. API-Plattformarchitektur
Gewährleisten Sie Skalierbarkeit, Wiederverwendung und Governance für Ihre API- und Plattformkomponenten.
h3. Canvas questions
#### Business Impact Canvas
Welche geschäftlichen Auswirkungen kann ein Ausfall oder Fehlverhalten der Capability oder Schnittstelle haben?
* *Risiken der Verfügbarkeit*: Was sind die potenziellen Risiken für die API-Verfügbarkeit?
* *Reduzierung von Risiken der Verfügbarkeit*: Wie lassen sich Verfügbarkeitsrisiken reduzieren?
* *Sicherheitsrisiken*: Welche potenziellen Sicherheitsrisiken sind mit der API assoziiert?
* *Reduktion der Sicherheitsrisiken*: Wie lassen sich Sicherheitsrisiken reduzieren?
* *Datenrisiken*: Welche potenziellen Risiken bestehen für die Datenintegrität oder -Vertraulichkeit?
* *Reduktion der Datenrisiken*: Wie lassen sich Datenrisiken reduzieren?
#### Location Canvas
Welche geopolitischen, regulatorischen, Netzwerk- und Vertrauensgrenzen betreffen diese Capability oder Schnittstelle?
* *Standort-/Vertrauensgruppen*: Welche geopolitischen, regulatorischen, netzwerkbezogenen oder vertrauensbezogenen Gruppen sind relevant?
* *Gruppenmerkmale*: Was sind die Merkmale dieser Gruppen, wie z. B. Standort, Vertrauensstufe oder Netzwerkexposition?
* *Relevante Standorte / Zonen*: Was sind die relevanten Standorte, Zonen oder Umgebungen innerhalb jeder Gruppe?
* *Standort-/Zonenmerkmale*: Was sind die Merkmale dieser Standorte oder Zonen, wie z. B. Eigentumsverhältnisse, Region oder Exposition?
* *Netzwerk- / Regulierungsentfernungen*: Welche Latenz-, Vertrauens-, Regulierungs- oder Konnektivitätsentfernungen bestehen zwischen den Standorten?
* *Entfernungsmerkmale*: Was sind die Merkmale dieser Entfernungen, wie z. B. Latenzempfindlichkeit, Aufenthaltsbeschränkungen oder Vertrauensgrenzen?
* *Konnektivitätsendpunkte*: Welche Konnektivitätsendpunkte oder Schnittstellen sind mit den Standorten verbunden?
* *Endpunktzugriffseigenschaften*: Welche Eigenschaften weisen diese Endpunkte auf, wie z. B. Sichtbarkeit, Protokoll, Sicherheit oder Zugriffsbeschränkungen?
#### Capacity Canvas
Welche Kapazität ist erforderlich, um die Nutzung der Capability oder Schnittstelle zu unterstützen?
* *Aktuelles Geschäftsvolumen*: Wie hoch sind das aktuelle Geschäftsvolumen und die Transaktionsraten?
* *Zukünftige Konsumtrends*: Was sind die erwarteten künftigen Konsumtrends?
* *Spitzenlast- und Verfügbarkeitsanforderungen*: Was sind die Spitzenlast- und Verfügbarkeitsanforderungen?
* *Caching-Strategien*: Welche Caching-Strategien können zur Performanceoptimierung eingesetzt werden?
* *Strategien zur Ratenbegrenzung*: Welche Strategien zur Ratenbegrenzung können genutzt werden, um die Nutzung zu steuern?
* *Strategien zur Skalierung*: Welche Strategien zur Skalierung können eingesetzt werden, um das Wachstum zu unterstützen?
h3. Other related resources
* *API-Metriken und -Analysen*: Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.
h2. 4. API-Design
Erstellen Sie API-Designs, die konsistent, wiederverwendbar und auf Geschäftszielen und gemeinsamen Standards basieren.
h3. Canvas questions
#### Domain Canvas
Welche wesentlichen Entitäten, Begriffe und Fachregeln muss die Capability oder Schnittstelle respektieren?
* *Ausgewählte Customer Journey Schritte*: Welche Customer Journey Schritte sind für diese Domäne relevant?
* *Grundlegende Entitäten & geschäftliche Bedeutung*: Welches sind die wesentlichen Entitäten und ihre Bedeutung für das Geschäft?
* *Attribute & geschäftliche Wichtigkeit*: Welches sind die Schlüsselattribute der einzelnen Entitäten und ihre geschäftliche Wichtigkeit?
* *Beziehungen zwischen Entitäten*: Welche Beziehungen bestehen zwischen den Entitäten?
* *Fachregeln, Compliance und Integrität*: Welche Fachregeln sowie Compliance- und Integritätsanforderungen beziehen sich auf die Entitäten?
* *Überlegungen zu Sicherheit und Datenschutz*: Welche Überlegungen zur Sicherheit und zum Datenschutz gibt es im Zusammenhang mit den Entitäten?
#### Interaction Canvas
Welche Arten von Interaktionen muss diese Capability oder Schnittstelle unterstützen, bevor ein konkretes Protokolldesign gewählt wird?
* *CRUD Interaktionen*: Sind hier Interaktionen im CRUD-Stil erforderlich?
* *CRUD Input- & Output-Modelle*: Was sind die Eingabe- und Ausgabemodelle für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
* *CRUD Verarbeitung & Validierung*: Was sind die Verarbeitungs- und Validierungsregeln für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
* *Abfragegesteuerte Interaktionen*: Welche Lese- oder Abfrageinteraktionen sind erforderlich, um Nutzerfragen zu beantworten?
* *Abfragegesteuerte Input- & Output-Modelle*: Was sind die Eingabe- und Ausgabemodelle für die abfragegesteuerten Interaktionen?
* *Abfragegesteuerte Verarbeitung & Validierung*: Was sind die Verarbeitungs- und Validierungsregeln für die abfragegesteuerten Interaktionen?
* *Befehlsgesteuerte Interaktionen*: Welche Befehle zur Zustandsänderung sind gegebenenfalls erforderlich?
* *Befehlsgesteuerte Input- & Output-Modelle*: Was sind die Eingabe- und Ausgabemodelle für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
* *Befehlsgesteuerte Verarbeitung & Validierung*: Was sind die Verarbeitungs- und Validierungsregeln für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
* *Eventgesteuerte Interaktionen*: Welche Ereignisse müssen gegebenenfalls veröffentlicht oder verarbeitet werden?
* *Eventgesteuerte Input- & Output-Modelle*: Was sind die Eingabe- und Ausgabemodelle für die ereignisgesteuerten Interaktionen, falls dieser Stil erforderlich ist?
* *Eventgesteuerte Verarbeitung & Validierung*: Was sind die Verarbeitungs- und Validierungsregeln für die ereignisgesteuerten Interaktionen, falls dieser Stil benötigt wird?
#### REST Canvas
Wie kann die API nach RESTful-Prinzipien gestaltet werden?
* *API-Ressourcen*: Was sind die Schlüsselressourcen, die von der API bereitgestellt werden?
* *API-Ressourcenmodell*: Wie sieht die Struktur des API-Ressourcenmodells aus?
* *HTTP-Methoden der API*: Welche HTTP-Methoden werden für die Interaktion mit den API-Ressourcen verwendet?
* *HTTP-Methoden-Beispiel*: Geben Sie für jede HTTP-Methode ein Beispiel für eine API-Anfrage und -Antwort an.
#### Event Canvas
Welche Ereignisse sind für die Capability oder Schnittstelle relevant und wie werden sie verarbeitet?
* *Nutzeraufgabe / Auslöser*: Welche Nutzeraktion oder welches Systemereignis löst diese Ereignisoperation aus?
* *Input / Event-Payload*: Welche Daten sind in der eingehenden Event-Payload enthalten? Geben Sie die Schlüsselattribute an.
* *Verarbeitung / Logik*: Beschreiben Sie die Verarbeitungslogik der Backend-Systeme, einschließlich Validierungen, Transformationen oder Routing-Entscheidungen.
* *Output / Event-Ergebnis*: Welches Event oder welche Bestätigungsmeldung wird erzeugt? Geben Sie die Attribute des Output-Payloads an.
#### GraphQL Canvas
Wie kann die API nach GraphQL-Prinzipien gestaltet werden?
* *API-Name*: Wie lautet der Name der GraphQL-API oder des Endpunkts?
* *Ziele der API-Nutzer*: Welche Probleme versuchen API-Nutzer zu lösen? Welche Daten benötigen sie?
* *Schlüsseltypen*: Welche zentralen Typen werden bereitgestellt (z. B. Nutzer, Bestellung, Produkt)?
* *Beziehungen*: Wie stehen die Typen in verschachtelten Abfragen zueinander?
* *Abfragen*: Welche typischen Abfragen sollten unterstützt werden?
* *Mutationen*: Welche Operationen verändern Daten (z.B. erstellen, aktualisieren, löschen)?
* *Subscriptions*: Gibt es Echtzeit-Updates oder Ereignisse, die Nutzer abonnieren können?
* *Autorisierungsregeln*: Wer darf auf welche Felder oder Typen zugreifen?
* *Einschränkungen für Nutzer*: Gibt es Paginierungs-, Filter- oder Ratenbegrenzungen?
* *Notizen / Offene Fragen*: Gibt es noch offene Entscheidungen oder Integrationsüberlegungen?
h3. Other related resources
* *API Design Prinzipien*: Ein prägnanter Leitfaden zu API-Benutzerfreundlichkeit, Auffindbarkeit und Konsistenz, der auf gemeinsamen Designregeln und echten Kundenbedürfnissen basiert.
* *Vertrag Erstes Design*: Ein Leitfaden, der für API-first-Ansätze plädiert, bei denen formale Verträge (z. B. OpenAPI) verwendet werden, um die Beteiligten vor der Entwicklung aufeinander abzustimmen.
h2. 5. API-Bereitstellung
Erstellen, Testen und Freigeben von APIs unter Verwendung moderner Bereitstellungspipelines und bewährter technischer Verfahren.
h3. Station questions
* Verwenden Sie Best Practices für die API-Entwicklung als Leitfaden für die Implementierung des validierten Schnittstellenvertrags mit etablierten Frameworks und Bibliotheken, um sicherzustellen, dass das Ergebnis wiederverwendbar und wartbar ist.
* Erstellen Sie die API-Implementierung auf Basis des validierten Schnittstellenvertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.
* Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.
* Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.
* Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.
* Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass die API die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.
* Bereitstellung von Frameworks, Bibliotheken und Standards für die API-Implementierung. Implementierung von CI/CD-Pipelines, Qualitätssicherungs-Frameworks und Tools zur Automatisierung der Bereitstellung.
* Selbst die besten API-Designs scheitern, wenn die Bereitstellung uneinheitlich ist. Diese Station stellt sicher, dass Ihre APIs qualitativ hochwertig erstellt, gründlich getestet und zuverlässig bereitgestellt werden - für schnellere Iterationen und mehr Vertrauen.
h3. Other related resources
* *Bewährte Praktiken der API-Entwicklung*: Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.
* *Bewährte Praktiken für API-Tests*: Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.
* *APIOps CI/CD für APIs*: Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.
* *Bewährte Praktiken für die API-Sicherheit*: Eine Reihe praktikabler Kontrollen zur Sicherung von APIs, einschließlich Authentifizierung, Autorisierung, Verschlüsselung, Ratenbegrenzung und Konformitätsprüfungen auf Pipeline-Ebene.
h2. 6. API-Audit
Stellen Sie sicher, dass APIs vor der Veröffentlichung und Bereitstellung den geschäftlichen, gestalterischen und betrieblichen Standards entsprechen.
h3. Station questions
* Führen Sie Audits durch, um sicherzustellen, dass APIs vor der Veröffentlichung organisatorische, technische und rechtliche Standards erfüllen.
* Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.
* Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.
* Richten Sie einen konsistenten Audit-Prozess ein, der die API-Bereitschaft über alle Lebenszyklusphasen hinweg anhand definierter Kriterien, Nachweise und Standards bewertet. Stellen Sie sicher, dass Lücken frühzeitig erkannt und vor der Veröffentlichung behoben werden.
* APIs sind langlebige Produkte und müssen den Erwartungen hinsichtlich Qualität, Konsistenz und Compliance entsprechen. Das Audit verbindet Designentscheidungen, Implementierung und Betriebsbereitschaft mit definierten Standards und reduziert so Risiken vor der Bereitstellung.
h3. Other related resources
* *API Audit Checkliste*: Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.
* *Bewährte Praktiken zur API-Einhaltung*: Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.
h2. 7. API-Veröffentlichung
Stellen Sie APIs mit der richtigen Dokumentation und den richtigen Prozessen sicher und klar für die richtige Zielgruppe bereit.
h3. Station questions
* Veröffentlichen Sie APIs in den entsprechenden Gateways und Umgebungen, um die Wiederverwendbarkeit für mehrere Nutzer zu unterstützen.
* Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.
* Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.
* Ermöglichung der Veröffentlichung von APIs in der jeweiligen Umgebung mit klaren Registrierungs- und Zugriffsmechanismen (z. B. API-Schlüssel, OAuth, Abonnementpläne) je nach den Nutzersegmenten und den Sicherheits- und Compliance-Anforderungen.
* Bei der Veröffentlichung geht es nicht nur um die Bereitstellung, sondern auch um die Auffindbarkeit, den Zugang und die Unterstützung. Wenn APIs nicht korrekt veröffentlicht werden, können sie nicht verwendet, wiederverwendet oder effektiv gesichert werden.
h3. Other related resources
* *APIOps CI/CD für APIs*: Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.
* *Bewährte Praktiken beim API-Onboarding*: Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.
* *API Audit Checkliste*: Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.
h2. 8. API-Monitoring & Verbesserung
Nutzen Sie Messgrößen und Feedback, um die API-Leistung zu verfolgen und kontinuierliche Verbesserungen voranzutreiben.
h3. Station questions
* Überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Akzeptanzmetriken (z. B. NPS).
* Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.
* Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.
* Einrichtung von Analyserahmen zur Verfolgung von Leistung und Engagement. Entwickeln Sie Feedbackschleifen, Analysetools und Engagementstrategien für APIs.
* Die API-Bereitstellung endet nicht mit dem Start. Ohne Überwachung können Teams weder die Akzeptanz noch die Leistung oder den ROI verbessern. Diese Station stellt sicher, dass APIs nützlich und sicher bleiben und sich mit den Geschäftsanforderungen weiterentwickeln.
h3. Other related resources
* *API-Metriken und -Analysen*: Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.
* *Strategien für das Engagement der API-Gemeinschaft*: Ein Leitfaden für die Förderung der API-Annahme durch die Pflege von Gemeinschaften durch Inhalte, Support-Kanäle, Feedback-Schleifen und Strategien für soziales Engagement.