{ "source": { "repository": "https://github.com/APIOpsCycles/apiops-cycles-method-data", "commit": "4418d7ccff492f591957f0e53fd9d476354041d7" }, "locales": [ "en", "fi", "fr", "de", "pt" ], "defaultLocale": "en", "generatedAt": "2026-07-24T13:03:14.377Z", "translations": { "de": { "labels": { "stations": "Bahnhöfe", "why_it_matters": "Warum diese Station existiert?", "outcomes": "Ergebnisse", "how_it_works": "So funktioniert es", "steps": "Schritte", "apply_in_work": "So sieht Erfolg aus", "related_metrolines": "Zu diesen Metrolinien gehören", "entry_criteria_title": "Startsignale", "exit_criteria_title": "Gut gemacht, wenn", "cycles.title": "Zyklusansichten", "cycles.description": "Zielgruppenspezifische Ansichten auf den APIOps-Cycles-Methoden.", "cycle.capability-productization-cycle.title": "Capability-Produktisierungszyklus", "cycle.capability-productization-cycle.description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird.", "cycle.capability-productization-cycle.purpose": "Identifizieren und produktisieren Sie wiederverwendbare digitale Capabilities, bevor Sie einen API-, Event-, Datei-, Stream-, Datenprodukt-, KI-Service-, direkte Integrations- oder hybriden Implementierungsstil waehlen.", "cycle.api-productization-cycle.title": "API-Produktisierungszyklus", "cycle.api-productization-cycle.description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs.", "cycle.api-productization-cycle.purpose": "API-fokussierte Method Journey für Teams, die bereits wissen, dass die vorgesehene Umsetzungsweise ein API-Produkt ist.", "cycle.integration-productization-cycle.title": "Integrationszyklus", "cycle.integration-productization-cycle.description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird.", "cycle.integration-productization-cycle.purpose": "Unterstuetzt das Design wiederverwendbarer Integrations-Capabilities, bevor ein API-, Event-, Datei-, Stream-, Datenprodukt-, direkte Integrations- oder hybrider Implementierungsstil gewaehlt wird.", "cycle.station.capability-strategy": "Capability-Strategie", "cycle.station.consumer-requirements-onboarding": "Nutzeranforderungen & Onboarding", "cycle.station.architecture-platform-decisions": "Architektur & Plattformentscheidungen", "cycle.station.solution-interface-design": "Lösungs- & Schnittstellendesign", "cycle.station.delivery-operations": "Bereitstellung & Betrieb", "cycle.station.quality-readiness-assurance": "Qualitäts- & Bereitschaftssicherung", "cycle.station.publishing-enablement": "Veroeffentlichung & Enablement", "cycle.station.monitoring-improvement": "Monitoring & Verbesserung", "cycle.station.api-product-strategy": "API-Produktstrategie", "cycle.station.api-consumer-experience": "API Consumer Experience", "cycle.station.api-platform-architecture": "API-Plattformarchitektur", "cycle.station.api-design": "API-Design", "cycle.station.api-delivery": "API-Bereitstellung", "cycle.station.api-audit": "API-Audit", "cycle.station.api-publishing": "API-Veröffentlichung", "cycle.station.monitoring-and-improving": "API-Monitoring & Verbesserung", "cycle.station.integration-capability-strategy": "Integrations-Capability-Strategie", "cycle.station.integration-consumer-requirements-onboarding": "Integrationsnutzeranforderungen & Onboarding", "cycle.station.integration-architecture-decision": "Integrationsarchitektur & Plattformentscheidungen", "cycle.station.integration-solution-design": "Integrationsdesign", "cycle.station.integration-delivery-operations": "Integrationsbereitstellung & Betrieb", "cycle.station.integration-readiness-assurance": "Integrationsbereitschaftssicherung", "cycle.station.capability-publishing": "Integrationsveroeffentlichung & Enablement", "cycle.station.integration-monitoring-improvement": "Integrationsmonitoring & Verbesserung", "cycle.capability-productization-cycle.station.api-product-strategy.description": "Rahmen Sie den Geschaeftsbedarf als wiederverwendbare Capability mit klarem Wert, Nutzern, Ownership und Geschaeftszielen, bevor der Implementierungsstil gewaehlt wird.", "cycle.capability-productization-cycle.station.api-consumer-experience.description": "Erfassen Sie Nutzeranforderungen, Onboarding-Bedarf, Einschränkungen, Serviceerwartungen und Verantwortlichkeiten der Anbieter.", "cycle.capability-productization-cycle.station.api-platform-architecture.description": "Nutzen Sie Anforderungen und Einschraenkungen, um Implementierungsstil, Architekturpattern und ermoeglichende Plattformfaehigkeiten auszuwaehlen.", "cycle.capability-productization-cycle.station.api-design.description": "Entwerfen Sie den Schnittstellenvertrag und das Interaktionsmodell für die gewählte Umsetzungsweise.", "cycle.capability-productization-cycle.station.api-delivery.description": "Bauen, testen, veröffentlichen und betreiben Sie die Capability mit der gewählten Umsetzungsweise und dem validierten Schnittstellenvertrag.", "cycle.capability-productization-cycle.station.api-audit.description": "Validieren Sie Schnittstellenvertrag, Kontrollen, Dokumentation, Supportmodell und operative Bereitschaft vor der Veroeffentlichung.", "cycle.capability-productization-cycle.station.api-publishing.description": "Veroeffentlichen Sie die Capability, damit Nutzer sie finden, bewerten, Zugriff beantragen, das Onboarding abschliessen, sie nutzen und Support erhalten koennen.", "cycle.capability-productization-cycle.station.monitoring-and-improving.description": "Überwachen Sie Capability-Gesundheit, Nutzerergebnisse, Zuverlässigkeit, Wiederverwendung und Verbesserungsmöglichkeiten.", "cycle.owner.business-owner": "Business Owner", "cycle.owner.domain-expert": "Domänenexperte", "cycle.owner.capability-owner": "Capability Owner", "cycle.owner.consumer-representative": "Nutzervertreter", "cycle.owner.enterprise-architect": "Enterprise Architect", "cycle.owner.platform-owner": "Platform Owner", "cycle.owner.api-product-owner": "API Product Owner", "cycle.owner.api-platform-owner": "API Platform Owner", "cycle.owner.integration-architect": "Integration Architect", "cycle.owner.solution-architect": "Solution Architect", "cycle.api-productization-cycle.station.api-product-strategy.description": "Bevor Sie etwas bauen, sollten Sie von Anfang an den Wert, die Benutzer und die Geschäftsziele Ihrer API definieren.", "cycle.api-productization-cycle.station.api-consumer-experience.description": "Stellen Sie sicher, dass Ihre API auffindbar, verständlich und nutzbar ist - vor und nach der Einführung.", "cycle.api-productization-cycle.station.api-platform-architecture.description": "Gewährleisten Sie Skalierbarkeit, Wiederverwendung und Governance für Ihre API- und Plattformkomponenten.", "cycle.api-productization-cycle.station.api-design.description": "Erstellen Sie API-Designs, die konsistent, wiederverwendbar und auf Geschäftszielen und gemeinsamen Standards basieren.", "cycle.api-productization-cycle.station.api-delivery.description": "Erstellen, Testen und Freigeben von APIs unter Verwendung moderner Bereitstellungspipelines und bewährter technischer Verfahren.", "cycle.api-productization-cycle.station.api-audit.description": "Stellen Sie sicher, dass APIs vor der Veröffentlichung und Bereitstellung den geschäftlichen, gestalterischen und betrieblichen Standards entsprechen.", "cycle.api-productization-cycle.station.api-publishing.description": "Stellen Sie APIs mit der richtigen Dokumentation und den richtigen Prozessen sicher und klar für die richtige Zielgruppe bereit.", "cycle.api-productization-cycle.station.monitoring-and-improving.description": "Nutzen Sie Messgrößen und Feedback, um die API-Leistung zu verfolgen und kontinuierliche Verbesserungen voranzutreiben.", "cycle.integration-productization-cycle.station.api-product-strategy.description": "Rahmen Sie die wiederverwendbare Integrations-Capability, den Geschaeftsbedarf, Ownership und erwartete Wiederverwendung, bevor der Implementierungsstil gewaehlt wird.", "cycle.integration-productization-cycle.station.api-consumer-experience.description": "Erfassen Sie Integrationsnutzer, Anbieter-Verantwortlichkeiten, Onboarding-Bedarf, Serviceerwartungen und operative Einschränkungen.", "cycle.integration-productization-cycle.station.api-platform-architecture.description": "Waehlen Sie Integrationsarchitektur, Implementierungsstil und Plattformfaehigkeiten unter Beruecksichtigung von Einschraenkungen und Governance-Modell.", "cycle.integration-productization-cycle.station.api-design.description": "Entwerfen Sie Schnittstellenvertrag, Schemas, Payloads und Interaktionsmuster fuer den gewaehlten Integrationsstil.", "cycle.integration-productization-cycle.station.api-delivery.description": "Bauen, testen, automatisieren, deployen und betreiben Sie die Integrations-Capability mit dem gewaehlten Implementierungsstil und dem validierten Schnittstellenvertrag.", "cycle.integration-productization-cycle.station.api-audit.description": "Sichern Sie Integrationsbereitschaft, Governance, Qualität, Sicherheit, Compliance und operative Nachweise vor der Veröffentlichung ab.", "cycle.integration-productization-cycle.station.api-publishing.description": "Veroeffentlichen Sie die Integrations-Capability, damit Teams sie finden, bewerten, Zugriff beantragen, das Onboarding abschliessen, wiederverwenden und Support erhalten koennen.", "cycle.integration-productization-cycle.station.monitoring-and-improving.description": "Überwachen Sie Integrationszuverlässigkeit, Wiederverwendung, Incidents, Performance, Nutzerergebnisse und Verbesserungsbedarf.", "cycle.automation-cycle.title": "Automatisierungszyklus", "cycle.automation-cycle.description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten.", "cycle.automation-cycle.purpose": "Produktisieren Sie Automatisierungsmöglichkeiten zu gesteuerten Workflows mit klaren Nutzern, Plattformen, Kontrollen, Bereitstellungspfaden, Enablement und Monitoring.", "cycle.audience.automation-owners": "Automation Owner", "cycle.audience.process-owners": "Prozessverantwortliche", "cycle.audience.automation-teams": "Automatisierungsteams", "cycle.station.automation-opportunity-strategy": "Automatisierungschance & Strategie", "cycle.station.process-user-requirements": "Prozess-/Nutzeranforderungen", "cycle.station.automation-platform-decision": "Automatisierungsplattformentscheidung", "cycle.station.automation-workflow-design": "Automatisierungs-Workflow-Design", "cycle.station.automation-delivery": "Automatisierungsbereitstellung & Betrieb", "cycle.station.automation-readiness-review": "Automatisierungsbereitschaftsprüfung", "cycle.station.automation-enablement": "Automatisierungs-Rollout & Enablement", "cycle.station.automation-monitoring-improvement": "Automatisierungsmonitoring & Verbesserung", "cycle.automation-cycle.station.api-product-strategy.description": "Identifizieren und priorisieren Sie Automatisierungsmöglichkeiten nach Wert, Machbarkeit, Risiko, Ownership und erwarteter Prozesswirkung.", "cycle.automation-cycle.station.api-consumer-experience.description": "Erfassen Sie Prozessnutzer, Rollen, Übergaben, Ausnahmen, Einschränkungen und Serviceerwartungen, bevor die Automatisierung entworfen wird.", "cycle.automation-cycle.station.api-platform-architecture.description": "Waehlen Sie Automatisierungsplattform, Runtime, Integrationsansatz, Governance-Kontrollen und operative Einschraenkungen.", "cycle.automation-cycle.station.api-design.description": "Entwerfen Sie Automatisierungsworkflow, Trigger, Entscheidungspunkte, Integrationen, Datenverarbeitung, relevante Schnittstellenvertraege und Ausnahmefaelle.", "cycle.automation-cycle.station.api-delivery.description": "Bauen, testen, deployen, dokumentieren und betreiben Sie die Automatisierung mit klarer Ownership, Kontrollen und Rollback-Pfaden.", "cycle.automation-cycle.station.api-audit.description": "Prüfen Sie Automatisierungsbereitschaft, Qualität, Risiko, Compliance, menschliche Aufsicht, Nachweise und Freigabekriterien.", "cycle.automation-cycle.station.api-publishing.description": "Befähigen Sie Nutzer und Betreiber mit Auffindbarkeit, Onboarding, Betriebsanweisungen, Supportpfaden und Änderungs kommunikation.", "cycle.automation-cycle.station.monitoring-and-improving.description": "Überwachen Sie Automatisierungsleistung, Ausnahmen, Zuverlässigkeit, Nutzerergebnisse, operative Auswirkungen und Verbesserungsmöglichkeiten.", "group.core-stations.title": "Kernstationen des Capability-Lebenszyklus", "group.core-stations.description": "Die Kernstationen des APIOps-Cycles-Methodengraphen, in denen Teams lernen, wiederverwendbare Capabilities über APIs, Events, Dateien, Streams, Datenprodukte und andere Integrationsstile hinweg zu entwerfen, bereitzustellen, zu steuern und kontinuierlich zu verbessern.", "group.sub-stations.title": "Unterstützende Stationen", "group.sub-stations.description": "Unterstützende Stationen bieten wiederverwendbare Praktiken, Entscheidungspunkte und Ressourcen, die in verschiedenen APIOps-Cycles-Routen genutzt werden können.", "station.api-product-strategy.title": "Strategie", "station.api-product-strategy.description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen.", "station.api-product-strategy.why_it_matters": "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden.", "station.api-product-strategy.apply_in_work": "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "station.api-product-strategy.outcomes": "Eine technologieunabhängige Capability Opportunity", "station.api-product-strategy.how_it_works": "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "station.api-consumer-experience.title": "Nutzeranforderungen & Onboarding", "station.api-consumer-experience.description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter.", "station.api-consumer-experience.why_it_matters": "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab.", "station.api-consumer-experience.how_it_works": "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "station.api-consumer-experience.how_it_works.1": "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "station.api-consumer-experience.how_it_works.2": "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "station.api-consumer-experience.apply_in_work": "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "station.api-consumer-experience.outcomes": "Explizite Nutzeranforderungen und Onboarding-Erwartungen", "station.api-platform-architecture.title": "Architektur & Plattformentscheidungen", "station.api-platform-architecture.description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen.", "station.api-platform-architecture.why_it_matters": "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen.", "station.api-platform-architecture.apply_in_work": "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "station.api-platform-architecture.outcomes": "Validierte Architektur- und Plattformentscheidung", "station.api-platform-architecture.how_it_works": "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "station.api-design.title": "Lösungs- & Schnittstellendesign", "station.api-design.description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung.", "station.api-design.why_it_matters": "Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist.", "station.api-design.apply_in_work": "Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.", "station.api-design.outcomes": "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise", "station.api-design.how_it_works": "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "station.api-delivery.title": "Bereitstellung & Betrieb", "station.api-delivery.description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um.", "station.api-delivery.why_it_matters": "Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird.", "station.api-delivery.apply_in_work": "Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.", "station.api-delivery.outcomes": "Eine bereitgestellte Capability, die mit dem validierten Schnittstellenvertrag übereinstimmt", "station.api-delivery.how_it_works": "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "station.api-audit.title": "Qualitäts- & Bereitschaftssicherung", "station.api-audit.description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung.", "station.api-audit.why_it_matters": "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung.", "station.api-audit.apply_in_work": "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "station.api-audit.outcomes": "Dokumentierte Bereitschaft für Veröffentlichung und Wiederverwendung", "station.api-audit.how_it_works": "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "station.api-publishing.title": "Veröffentlichung & Enablement", "station.api-publishing.description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können.", "station.api-publishing.why_it_matters": "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen.", "station.api-publishing.apply_in_work": "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "station.api-publishing.outcomes": "Eine auffindbare und nutzbare Capability", "station.api-publishing.how_it_works": "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "station.monitoring-and-improving.title": "Monitoring & Verbesserung", "station.monitoring-and-improving.description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung.", "station.monitoring-and-improving.why_it_matters": "Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern.", "station.monitoring-and-improving.apply_in_work": "Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.", "station.monitoring-and-improving.outcomes": "Gemessene Capability-Gesundheit und Wertbeitrag", "station.monitoring-and-improving.how_it_works": "Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.", "station.user-experience.title": "Benutzerfreundlichkeit - Entwerfen Sie APIs mit dem Benutzer im Hinterkopf", "station.user-experience.description": "Stellen Sie sicher, dass die APIs mit Blick auf den Endnutzer entwickelt werden und eine nahtlose und intuitive Erfahrung bieten.", "station.user-experience.why_it_matters": "APIs sind nicht nur technische Produkte, sondern auch Produkte für die Benutzer. Ein schlechtes Benutzererlebnis kann zu geringer Akzeptanz und Frustration führen. Diese Station hilft Teams bei der Entwicklung von APIs, die benutzerfreundlich sind und die Bedürfnisse der Nutzer erfüllen.", "station.user-experience.apply_in_work": "Bereitstellung von Richtlinien, Vorlagen und Tools für die Benutzererfahrung beim API-Design. Sicherstellen, dass die Teams nutzerzentrierte Designpraktiken befolgen und Nutzerfeedback in API-Iterationen einbeziehen.", "station.user-experience.outcomes": "APIs, die auf die Bedürfnisse der Nutzer abgestimmt sind", "station.user-experience.how_it_works": "Verwendung von User Personas, um die Bedürfnisse und Erwartungen der Endnutzer zu verstehen", "station.market-insights.title": "Markteinblicke - Verstehen Sie die API-Landschaft", "station.market-insights.description": "Analysieren Sie Markttrends, APIs von Mitbewerbern und Industriestandards, um eine API-Strategie zu entwickeln.", "station.market-insights.why_it_matters": "Das Verständnis der Marktlandschaft hilft Teams, Chancen zu erkennen, Fallstricke zu vermeiden und ihre APIs an Branchenstandards auszurichten. Diese Station bietet Tools zur Analyse von Markttrends und Angeboten von Wettbewerbern.", "station.market-insights.apply_in_work": "Bereitstellung von Marktforschungstools, Vorlagen für Konkurrenzanalysen und Ressourcen für Industriestandards. Sicherstellen, dass die Teams über Markttrends informiert bleiben und die Erkenntnisse in die API-Strategie einfließen.", "station.market-insights.outcomes": "Analyse von Markttrends und APIs von Wettbewerbern", "station.market-insights.how_it_works": "Führen Sie Marktforschung durch, um Trends, Chancen und Bedrohungen in der API-Landschaft zu identifizieren.", "station.business-goals.title": "Geschäftsziele - APIs an Geschäftszielen ausrichten", "station.business-goals.description": "Sicherstellen, dass die APIs mit den Geschäftszielen übereinstimmen und zu den allgemeinen Unternehmenszielen beitragen.", "station.business-goals.why_it_matters": "APIs sollten nicht isoliert entwickelt werden; sie müssen Geschäftsziele unterstützen und vorantreiben. Diese Station hilft Teams dabei, ihre APIs an strategischen Zielen auszurichten und sicherzustellen, dass sie einen echten Geschäftswert liefern.", "station.business-goals.apply_in_work": "Bereitstellung von Frameworks, Vorlagen und Tools für die Geschäftsausrichtung zur Definition des API-Geschäftswerts. Sicherstellen, dass die Teams die APIs regelmäßig überprüfen und mit den sich ändernden Geschäftszielen abstimmen.", "station.business-goals.outcomes": "APIs, die auf die Unternehmensziele abgestimmt sind", "station.business-goals.how_it_works": "Definieren Sie die Geschäftsziele und wie APIs diese unterstützen können, indem Sie **die Business Model Canvas** verwenden. Wenn Ihr Geschäft darin besteht, APIs bereitzustellen, gehen Sie durch *die API-Produktstrategie-Station* und füllen Sie **die API Business Model Canvas** aus.", "station.competitive-analysis.title": "Wettbewerbsanalyse - Vorsprung auf dem API-Markt", "station.competitive-analysis.description": "Analysieren Sie die APIs der Wettbewerber, um Stärken, Schwächen und Möglichkeiten zur Differenzierung zu ermitteln.", "station.competitive-analysis.why_it_matters": "Das Verständnis der Wettbewerbslandschaft hilft den Teams, Lücken, Möglichkeiten und verbesserungswürdige Bereiche für ihre APIs zu identifizieren. Diese Station bietet Tools zur Analyse von Wettbewerbern und zur Information über die API-Strategie.", "station.competitive-analysis.apply_in_work": "Bereitstellung von Tools, Vorlagen und Ressourcen zur Wettbewerbsanalyse. Sicherstellen, dass die Teams regelmäßig die Konkurrenz analysieren und die Erkenntnisse in die API-Strategie und das Design einfließen lassen.", "station.competitive-analysis.outcomes": "Analyse der Stärken und Schwächen von APIs der Wettbewerber", "station.competitive-analysis.how_it_works": "Führen Sie eine Wettbewerbsanalyse durch, um die wichtigsten Wettbewerber, ihre API-Angebote sowie ihre Stärken und Schwächen zu ermitteln.", "station.ecosystem-vision.title": "Ökosystem-Vision - Aufbau von APIs für ein florierendes Ökosystem", "station.ecosystem-vision.description": "Entwickeln Sie eine Vision dafür, wie Ihre APIs in ein größeres Ökosystem passen, das Zusammenarbeit und Innovation ermöglicht.", "station.ecosystem-vision.why_it_matters": "APIs sind keine eigenständigen Produkte; sie sind Teil eines größeren Ökosystems. Diese Station hilft Teams zu definieren, wie ihre APIs mit anderen Systemen, Plattformen und Diensten interagieren, um ein florierendes Ökosystem zu schaffen, das die Zusammenarbeit und Innovation fördert.", "station.ecosystem-vision.apply_in_work": "Bereitstellung von Rahmenwerken für die Vision des Ökosystems, Strategien für die Einbindung von Partnern und Integrationsrichtlinien. Sicherstellen, dass die Teams APIs mit Blick auf das Ökosystem entwickeln und die Zusammenarbeit zwischen den Partnern fördern.", "station.ecosystem-vision.outcomes": "Klare Vision eines Ökosystems für APIs definiert", "station.ecosystem-vision.how_it_works": "Definieren Sie die Vision des Ökosystems für Ihre APIs, einschließlich der Frage, wie sie mit anderen Systemen und Plattformen interagieren werden.", "station.scalable-infrastructure.title": "Skalierbare Infrastruktur - APIs auf einem soliden Fundament aufbauen", "station.scalable-infrastructure.description": "Stellen Sie sicher, dass Ihre API-Infrastruktur skalierbar ist, um der wachsenden Nachfrage gerecht zu werden und eine hohe Verfügbarkeit zu gewährleisten.", "station.scalable-infrastructure.why_it_matters": "APIs müssen auf einer robusten Infrastruktur aufgebaut werden, die den zunehmenden Datenverkehr bewältigen und eine hohe Verfügbarkeit gewährleisten kann. Diese Station bietet Richtlinien für den Entwurf und die Implementierung einer skalierbaren Infrastruktur, die das Wachstum und die Leistung von APIs unterstützt.", "station.scalable-infrastructure.apply_in_work": "Bereitstellung von Richtlinien für das Infrastrukturdesign, Cloud-nativen Mustern und Überwachungstools. Sicherstellen, dass die Teams eine skalierbare Infrastruktur implementieren, die sich an wechselnde Anforderungen anpassen kann und die API-Leistung unterstützt.", "station.scalable-infrastructure.outcomes": "Skalierbare und widerstandsfähige API-Infrastruktur", "station.scalable-infrastructure.how_it_works": "Entwerfen Sie eine skalierbare und robuste API-Infrastruktur unter Verwendung von Cloud-nativen Mustern und Technologien.", "station.legal-and-compliance.title": "Rechtliche Aspekte und Einhaltung von Vorschriften - Sicherstellen, dass APIs den regulatorischen Standards entsprechen", "station.legal-and-compliance.description": "Stellen Sie sicher, dass APIs den gesetzlichen und behördlichen Anforderungen entsprechen, um Ihr Unternehmen und Ihre Benutzer zu schützen.", "station.legal-and-compliance.why_it_matters": "APIs müssen gesetzliche und regulatorische Standards einhalten, um Ihr Unternehmen und Ihre Benutzer zu schützen. Diese Station bietet Tools und Richtlinien, die sicherstellen, dass APIs die Compliance-Anforderungen erfüllen, rechtliche Risiken verringern und den Datenschutz gewährleisten.", "station.legal-and-compliance.apply_in_work": "Bereitstellung von rechtlichen und Compliance-Rahmenwerken, Checklisten und Tools zur Gewährleistung der API-Compliance. Sicherstellen, dass die Teams die rechtlichen Anforderungen beim Entwurf, der Entwicklung und der Veröffentlichung von APIs verstehen und umsetzen.", "station.legal-and-compliance.outcomes": "APIs, die mit gesetzlichen und regulatorischen Standards übereinstimmen", "station.legal-and-compliance.how_it_works": "Identifizieren Sie rechtliche und regulatorische Anforderungen, die für Ihre APIs gelten, wie z. B. Datenschutz, Privatsphäre und Sicherheitsstandards.", "station.security-and-privacy.title": "Sicherheit und Datenschutz - Schützen Sie Ihre APIs und Benutzer", "station.security-and-privacy.description": "Implementierung von Sicherheits- und Datenschutzmaßnahmen zum Schutz von APIs und Nutzerdaten vor Bedrohungen und Verstößen.", "station.security-and-privacy.why_it_matters": "APIs sind anfällig für Sicherheitsbedrohungen und Datenschutzverletzungen. Diese Station bietet Richtlinien für die Implementierung von Sicherheits- und Datenschutzmaßnahmen, die APIs und Nutzerdaten schützen und Vertrauen und Compliance gewährleisten.", "station.security-and-privacy.apply_in_work": "Bereitstellung von Sicherheits-Frameworks, Tools und Best Practices für API-Sicherheit und Datenschutz. Sicherstellen, dass die Teams Sicherheitsmaßnahmen während des gesamten API-Lebenszyklus implementieren, vom Entwurf bis zur Veröffentlichung und Überwachung.", "station.security-and-privacy.outcomes": "Gegen Bedrohungen und Schwachstellen gesicherte APIs", "station.security-and-privacy.how_it_works": "Implementieren Sie Sicherheitsmaßnahmen wie Authentifizierung, Autorisierung, Verschlüsselung und Ratenbegrenzung, um APIs vor Bedrohungen zu schützen.", "station.design-standards.title": "Designstandards - Sicherstellung eines konsistenten und qualitativ hochwertigen API-Designs", "station.design-standards.description": "Festlegung von Designstandards und -richtlinien, um ein einheitliches und hochwertiges API-Design im gesamten Unternehmen zu gewährleisten.", "station.design-standards.why_it_matters": "Ein konsistentes und qualitativ hochwertiges API-Design ist für die Benutzerfreundlichkeit, Wartbarkeit und Skalierbarkeit unerlässlich. Diese Station bietet Designstandards und Richtlinien, die Teams bei der Erstellung von APIs helfen, die einfach zu verwenden, zu verstehen und zu warten sind.", "station.design-standards.apply_in_work": "Bereitstellung von Dokumentationen zu Designstandards, wiederverwendbaren Komponenten und Designüberprüfungsprozessen. Sicherstellen, dass die Teams die Designstandards befolgen und regelmäßige Überprüfungen durchführen, um ein qualitativ hochwertiges API-Design zu gewährleisten.", "station.design-standards.outcomes": "Einheitliches API-Design in der gesamten Organisation", "station.design-standards.how_it_works": "Definition von Designstandards und Richtlinien für das API-Design, einschließlich Benennungskonventionen, Antwortformaten und Fehlerbehandlung.", "station.vendor-management.title": "Vendor Management - Verwalten von API-Integrationen von Drittanbietern", "station.vendor-management.description": "Effiziente Verwaltung von Drittanbieter-APIs und Integrationen zur Gewährleistung von Zuverlässigkeit und Compliance.", "station.vendor-management.why_it_matters": "APIs von Drittanbietern können Risiken und Abhängigkeiten mit sich bringen, die sich auf Ihr API-Ökosystem auswirken. Diese Station enthält Richtlinien für die Verwaltung von Anbieterbeziehungen, die Zuverlässigkeit, Compliance und Übereinstimmung mit Ihrer API-Strategie sicherstellen.", "station.vendor-management.apply_in_work": "Bereitstellung von Rahmenwerken für die Anbieterverwaltung, Bewertungskriterien und Überwachungsinstrumenten. Sicherstellen, dass die Teams API-Anbieter von Drittanbietern effektiv verwalten, um Zuverlässigkeit, Compliance und Übereinstimmung mit den Unternehmensstandards zu gewährleisten.", "station.vendor-management.outcomes": "Effektive Prozesse für das Lieferantenmanagement eingeführt", "station.vendor-management.how_it_works": "Einführung von Prozessen für das Anbietermanagement, um Drittanbieter von APIs zu bewerten, einzubinden und zu überwachen.", "station.contract-design.title": "Vertragsgestaltung - Definieren Sie klare Schnittstellenverträge", "station.contract-design.description": "Erstellen Sie klare und genau definierte Schnittstellenverträge, die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien umreißen.", "station.contract-design.why_it_matters": "Schnittstellenverträge sind wichtig, um Klarheit und Übereinstimmung zwischen API-Anbietern und Kunden zu gewährleisten. Diese Station bietet Richtlinien für die Gestaltung von Schnittstellenverträgen, die klar, umfassend und leicht verständlich sind.", "station.contract-design.apply_in_work": "Bereitstellung von Vertragsentwurfsvorlagen, standardisierten Formaten und Überprüfungsprozessen. Sicherstellen, dass Teams klare und gut definierte Schnittstellenverträge erstellen, die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien umreißen.", "station.contract-design.outcomes": "Klare Schnittstellenverträge für jede API definiert", "station.contract-design.how_it_works": "Definieren Sie Schnittstellenverträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "station.development.title": "Entwicklung - Erstellen von APIs mit bewährten Praktiken", "station.development.description": "Implementierung von APIs unter Verwendung von Best Practices und Frameworks zur Gewährleistung von Qualität, Wartbarkeit und Skalierbarkeit.", "station.development.why_it_matters": "Die API-Entwicklung ist eine entscheidende Phase, die die Qualität und Zuverlässigkeit der API bestimmt. Diese Station bietet Best Practices und Frameworks für die API-Entwicklung, die sicherstellen, dass APIs nach hohen Standards erstellt werden und effektiv gewartet und skaliert werden können.", "station.development.apply_in_work": "Bereitstellung von Entwicklungsrahmen, Bibliotheken und Codierungsstandards für die API-Implementierung. Sicherstellen, dass die Teams Best Practices befolgen und Code-Reviews durchführen, um eine hochwertige API-Entwicklung zu gewährleisten.", "station.development.outcomes": "APIs, die unter Verwendung bewährter Verfahren und Rahmenwerke entwickelt werden", "station.development.how_it_works": "Verwendung etablierter Frameworks und Bibliotheken zur Implementierung von APIs, um sicherzustellen, dass sie wiederverwendbar und wartbar sind.", "station.ci-cd.title": "CI/CD - Automatisierte API-Bereitstellung", "station.ci-cd.description": "Implementieren Sie Pipelines für kontinuierliche Integration und kontinuierliche Bereitstellung (CI/CD), um die API-Bereitstellung zu automatisieren und eine gleichbleibende Qualität zu gewährleisten.", "station.ci-cd.why_it_matters": "CI/CD ist wichtig, um sicherzustellen, dass APIs schnell, zuverlässig und in hoher Qualität bereitgestellt werden. Diese Station bietet Richtlinien für die Implementierung von CI/CD-Pipelines, die die Build-, Test- und Bereitstellungsprozesse für APIs automatisieren.", "station.ci-cd.apply_in_work": "Bereitstellung von CI/CD-Frameworks, Tools und Best Practices für die API-Bereitstellung. Sicherstellen, dass Teams automatisierte Pipelines implementieren, die die kontinuierliche Integration, Prüfung und Bereitstellung von APIs unterstützen.", "station.ci-cd.outcomes": "Automatisierte CI/CD-Pipelines für die API-Bereitstellung eingerichtet", "station.ci-cd.how_it_works": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "station.test-automation.title": "Testautomatisierung - Sicherung der API-Qualität", "station.test-automation.description": "Implementieren Sie automatisierte Testverfahren, um die Qualität, Zuverlässigkeit und Leistung von APIs sicherzustellen.", "station.test-automation.why_it_matters": "Automatisierte Tests sind entscheidend, um sicherzustellen, dass APIs korrekt funktionieren und den Qualitätsstandards entsprechen. Diese Station bietet Richtlinien für die Implementierung automatisierter Testverfahren, die funktionale, Sicherheits- und Leistungstests für APIs umfassen.", "station.test-automation.apply_in_work": "Bereitstellung von Testautomatisierungs-Frameworks, Tools und Best Practices für API-Tests. Sicherstellen, dass Teams automatisierte Tests implementieren, die funktionale, Sicherheits- und Leistungsaspekte von APIs abdecken.", "station.test-automation.outcomes": "Automatisierte Testverfahren für APIs implementiert", "station.test-automation.how_it_works": "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren.", "station.release-management.title": "Release Management - Effektive Verwaltung von API-Releases", "station.release-management.description": "Implementierung von Release-Management-Verfahren zur Gewährleistung reibungsloser und kontrollierter API-Releases.", "station.release-management.why_it_matters": "Ein effektives Versionsmanagement ist unerlässlich, um sicherzustellen, dass API-Versionen reibungslos, kontrolliert und auf die Geschäftsanforderungen abgestimmt sind. Diese Station bietet Richtlinien für die Verwaltung von API-Releases, einschließlich Versionierung, Bereitstellungsstrategien und Rollback-Verfahren.", "station.release-management.apply_in_work": "Bereitstellung von Rahmenwerken für die Versionsverwaltung, Richtlinien für die Versionierung und Strategien für die Bereitstellung. Sicherstellen, dass die Teams Best Practices für die Verwaltung von API-Releases befolgen, einschließlich Versionierung, Bereitstellung und Rollback-Verfahren.", "station.release-management.outcomes": "Kontrollierte und reibungslose API-Freigaben", "station.release-management.how_it_works": "Definieren Sie Versionsstrategien für APIs, um Änderungen zu verwalten und Abwärtskompatibilität zu gewährleisten.", "station.service-agreements.title": "Servicevereinbarungen - Definieren Sie API-Service-Levels", "station.service-agreements.description": "Erstellen Sie Dienstleistungsvereinbarungen, in denen die Erwartungen, das Leistungsniveau und die Zuständigkeiten von API-Anbietern und Kunden festgelegt sind.", "station.service-agreements.why_it_matters": "Dienstleistungsvereinbarungen sind wichtig, um Klarheit und Übereinstimmung zwischen API-Anbietern und Kunden zu gewährleisten. Diese Station bietet Richtlinien für die Erstellung von Servicevereinbarungen, die Erwartungen, Servicelevel und Verantwortlichkeiten umreißen und so Missverständnisse und Streitigkeiten reduzieren.", "station.service-agreements.apply_in_work": "Bereitstellung von Vorlagen für Servicevereinbarungen, standardisierten Formaten und Überprüfungsprozessen. Stellen Sie sicher, dass die Teams klare und genau definierte Servicevereinbarungen erstellen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für API-Anbieter und -Kunden festgelegt sind.", "station.service-agreements.outcomes": "Klare Dienstvereinbarungen für jede API definiert", "station.service-agreements.how_it_works": "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "station.api-consumer-adoption.title": "Nutzerakzeptanz - Förderung der API-Nutzung", "station.api-consumer-adoption.description": "Implementierung von Strategien zur Förderung der Akzeptanz und des Engagements von Nutzer, um sicherzustellen, dass APIs effektiv genutzt werden.", "station.api-consumer-adoption.why_it_matters": "Die Förderung der Akzeptanz von APIs durch die Nutzer ist entscheidend für die Realisierung des Werts von APIs. Diese Station bietet Strategien und Best Practices für die Einbindung von Nutzern, um sicherzustellen, dass sie verstehen, wie APIs effektiv genutzt werden können und einen Nutzen aus ihnen ziehen.", "station.api-consumer-adoption.apply_in_work": "Bereitstellung von Onboarding-Ressourcen, Lehrmaterial und Strategien zur Einbindung von Nutzer. Sicherstellen, dass die Teams Strategien umsetzen, die die Akzeptanz, das Engagement und die Zufriedenheit der Nutzer fördern.", "station.api-consumer-adoption.outcomes": "Strategien zur Übernahme von API durch die Nutzer umgesetzt", "station.api-consumer-adoption.how_it_works": "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit Nutzer verstehen, wie sie APIs effektiv nutzen können.", "station.api-promotion.title": "API-Promotion - Erhöhen Sie die Sichtbarkeit und Nutzung von APIs", "station.api-promotion.description": "Förderung von APIs, um die Sichtbarkeit, Nutzung und Akzeptanz bei den Zielgruppen zu erhöhen.", "station.api-promotion.why_it_matters": "Die Förderung von APIs ist wichtig, um ihre Sichtbarkeit zu erhöhen und ihre Nutzung zu fördern. Diese Station bietet Strategien und Best Practices für eine effektive Werbung für APIs bei den Zielgruppen, um sicherzustellen, dass diese die APIs kennen und ihren Wert verstehen.", "station.api-promotion.apply_in_work": "Bereitstellung von Marketingstrategien, Werbematerialien und Ressourcen für das Engagement in der Gemeinschaft. Sicherstellen, dass die Teams effektive API-Werbestrategien umsetzen, die die Sichtbarkeit, Nutzung und Akzeptanz bei den Zielgruppen erhöhen.", "station.api-promotion.outcomes": "Umgesetzte API-Förderstrategien", "station.api-promotion.how_it_works": "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "station.partner-integration.title": "Partnerintegration - Zusammenarbeit mit Partnern", "station.partner-integration.description": "Erleichtern Sie die Integration von Partnern, um die API-Funktionen zu verbessern und die Reichweite zu erhöhen.", "station.partner-integration.why_it_matters": "Die Integration von Partnern kann die API-Funktionen verbessern und die Reichweite erhöhen. Diese Station enthält Richtlinien für die Zusammenarbeit mit Partnern zur Integration ihrer APIs, um nahtlose Interoperabilität und Wertschöpfung zu gewährleisten.", "station.partner-integration.apply_in_work": "Bereitstellung von Frameworks, Richtlinien und Überwachungstools für die Partnerintegration. Sicherstellen, dass die Teams effektiv mit Partnern zusammenarbeiten, um die API-Funktionen zu verbessern, die Reichweite zu erhöhen und Innovationen voranzutreiben.", "station.partner-integration.outcomes": "Prozesse zur Partnerintegration etabliert", "station.partner-integration.how_it_works": "Identifizieren Sie potenzielle Partner, deren APIs Ihre API-Fähigkeiten und Ihr Wertversprechen verbessern können.", "station.api-mindset.title": "API-Mentalität - Fördern Sie eine API-First-Kultur", "station.api-mindset.description": "Fördern Sie eine API-zentrierte Denkweise im gesamten Unternehmen, um Innovation und Zusammenarbeit voranzutreiben.", "station.api-mindset.why_it_matters": "Eine API-zentrierte Denkweise ist entscheidend für die Förderung von Innovation und Zusammenarbeit im gesamten Unternehmen. Diese Station bietet Strategien für die Kultivierung einer API-first-Kultur, die sicherstellt, dass APIs als strategische Assets betrachtet werden, die den Geschäftswert steigern.", "station.api-mindset.apply_in_work": "Bereitstellung von Schulungsprogrammen, Ressourcen und Kommunikationsstrategien zur Förderung einer API-zentrierten Kultur. Sicherstellen, dass die Teams den Wert von APIs verstehen und befähigt werden, die API-Strategie und -Initiativen voranzutreiben.", "station.api-mindset.outcomes": "Einführung einer API-zentrierten Kultur im gesamten Unternehmen", "station.api-mindset.how_it_works": "Förderung des Wertes von APIs als strategische Ressourcen, die den Geschäftswert und die Innovation vorantreiben.", "station.roles-and-responsibilities.title": "Rollen und Zuständigkeiten - API-Team-Strukturen definieren", "station.roles-and-responsibilities.description": "Definieren Sie klare Rollen und Verantwortlichkeiten für API-Teams, um eine effektive Zusammenarbeit und Verantwortlichkeit zu gewährleisten.", "station.roles-and-responsibilities.why_it_matters": "Klare Rollen und Zuständigkeiten sind für eine effektive Zusammenarbeit und Verantwortlichkeit in API-Teams unerlässlich. Diese Station bietet Richtlinien für die Definition von Teamstrukturen, Rollen und Verantwortlichkeiten, um sicherzustellen, dass jeder seinen Beitrag zu API-Initiativen versteht.", "station.roles-and-responsibilities.apply_in_work": "Bereitstellung von Richtlinien für die Teamstruktur, Rollendefinitionen und Kommunikationsstrategien. Stellen Sie sicher, dass Teams klare Rollen und Verantwortlichkeiten haben, die eine effektive Zusammenarbeit und Verantwortlichkeit bei API-Initiativen fördern.", "station.roles-and-responsibilities.outcomes": "Klare Rollen und Verantwortlichkeiten für API-Teams definiert", "station.roles-and-responsibilities.how_it_works": "Definieren Sie Teamstrukturen und Rollen für API-Teams, einschließlich API-Produktverantwortliche, Entwickler, Architekten und Betriebsleiter.", "station.upskilling.title": "Upskilling - Erweiterung der API-Fähigkeiten und -Kenntnisse", "station.upskilling.description": "Bereitstellung von Schulungen und Ressourcen zur Verbesserung der API-Fähigkeiten und -Kenntnisse in der gesamten Organisation.", "station.upskilling.why_it_matters": "Kontinuierliches Lernen und Weiterbildung sind unerlässlich, um API-Teams mit den neuesten Technologien, Praktiken und Trends auf dem Laufenden zu halten. Diese Station bietet Schulungsprogramme und Ressourcen zur Verbesserung der API-Fähigkeiten und -Kenntnisse, um sicherzustellen, dass die Teams für die Bereitstellung hochwertiger APIs gerüstet sind.", "station.upskilling.apply_in_work": "Bereitstellung von Schulungsprogrammen, Ressourcen und Bewertungsinstrumenten zur Verbesserung der API-Fähigkeiten und -Kenntnisse. Sicherstellen, dass Teams Zugang zu kontinuierlichen Lernmöglichkeiten haben, die sie befähigen, API-Innovation und Qualität voranzutreiben.", "station.upskilling.outcomes": "Verbesserung der API-Fähigkeiten und -Kenntnisse in der gesamten Organisation", "station.upskilling.how_it_works": "Identifizieren Sie wichtige API-Fähigkeiten und Wissensbereiche, die verbessert werden müssen, wie z. B. API-Design, Sicherheit und Leistung.", "station.operating-guidelines.title": "Betriebsleitlinien - Einrichtung einer API-Governance", "station.operating-guidelines.description": "Festlegung von Betriebsrichtlinien und Governance-Praktiken zur Gewährleistung einer einheitlichen API-Verwaltung und -Qualität.", "station.operating-guidelines.why_it_matters": "Eine effektive API-Governance ist für die Sicherstellung einer konsistenten API-Verwaltung, Qualität und Compliance unerlässlich. Diese Station bietet Betriebsrichtlinien und Governance-Praktiken, die Teams bei der effektiven Verwaltung von APIs helfen und sicherstellen, dass diese mit den Unternehmensstandards und Best Practices übereinstimmen.", "station.operating-guidelines.apply_in_work": "Bereitstellung von Betriebsrichtlinien, Governance-Frameworks und Überwachungstools für die API-Verwaltung. Sicherstellen, dass Teams etablierte Praktiken befolgen, die eine konsistente API-Verwaltung, Qualität und die Einhaltung von Unternehmensstandards fördern.", "station.operating-guidelines.outcomes": "API-Governance-Verfahren eingeführt", "station.operating-guidelines.how_it_works": "Definieren Sie Betriebsrichtlinien auf der Grundlage von APIOps-Zyklen, die die Prozesse, Standards und bewährten Verfahren für die API-Verwaltung umreißen.", "station.portfolio-management.title": "Portfoliomanagement - Effektive Verwaltung des API-Portfolios", "station.portfolio-management.description": "Effiziente Verwaltung des API-Portfolios, um die Übereinstimmung mit den Geschäftszielen und strategischen Initiativen zu gewährleisten.", "station.portfolio-management.why_it_matters": "Eine effektive Verwaltung des API-Portfolios ist unerlässlich, um sicherzustellen, dass APIs mit den Geschäftszielen und strategischen Initiativen übereinstimmen. Diese Station bietet Richtlinien für die Verwaltung des API-Portfolios und stellt sicher, dass APIs priorisiert, überwacht und optimiert werden, um maximalen Wert zu liefern.", "station.portfolio-management.apply_in_work": "Bereitstellung von Rahmenwerken für das Portfoliomanagement, Priorisierungskriterien und Überwachungstools für das API-Management. Sicherstellen, dass die Teams das API-Portfolio effektiv verwalten und dabei die Ausrichtung an Geschäftszielen und strategischen Initiativen sowie die Bereitstellung eines maximalen Werts gewährleisten.", "station.portfolio-management.outcomes": "Einführung von API-Portfolioverwaltungspraktiken", "station.portfolio-management.how_it_works": "Definition von Portfoliomanagementverfahren, die die Prozesse zur Verwaltung des API-Portfolios, einschließlich Priorisierung, Überwachung und Optimierung, umreißen.", "station.budget-and-resource-management.title": "Budget- und Ressourcenmanagement - Optimierung von API-Investitionen", "station.budget-and-resource-management.description": "Optimieren Sie das Budget- und Ressourcenmanagement für API-Initiativen, um eine effektive Investition und Ressourcenzuweisung zu gewährleisten.", "station.budget-and-resource-management.why_it_matters": "Ein effektives Budget- und Ressourcenmanagement ist unerlässlich, um sicherzustellen, dass API-Initiativen gut finanziert und mit Ressourcen ausgestattet sind. Diese Station bietet Richtlinien für die Optimierung der Budget- und Ressourcenverwaltung, um sicherzustellen, dass API-Initiativen mit den Unternehmenszielen übereinstimmen und maximalen Wert liefern.", "station.budget-and-resource-management.apply_in_work": "Bereitstellung von Rahmenwerken für die Budgetverwaltung, Priorisierungskriterien und Überwachungsinstrumenten für API-Initiativen. Sicherstellen, dass die Teams Budgets und Ressourcen effektiv verwalten und die Investitionen in die API-Entwicklung und -Verwaltung optimieren, um einen maximalen Nutzen zu erzielen.", "station.budget-and-resource-management.outcomes": "Budget- und Ressourcenmanagementverfahren für API-Initiativen eingeführt", "station.budget-and-resource-management.how_it_works": "Definieren Sie Budget- und Ressourcenverwaltungspraktiken, die die Prozesse für die Verwaltung von Budgets und Ressourcen für API-Initiativen umreißen.", "station.api-product-strategy.outcomes.1": "Gemeinsame Sprache zwischen Produkt, Design und Technik", "station.api-product-strategy.outcomes.2": "Ein solides Argument für die Finanzierung/Bewilligung", "station.api-product-strategy.how_it_works.1": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "station.api-product-strategy.how_it_works.2": "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "station.api-product-strategy.how_it_works.3": "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "station.api-consumer-experience.outcomes.1": "Definieren Sie die API-Erlebnisreise", "station.api-consumer-experience.outcomes.2": "Onboarding, Dokumentation und Feedback planen", "station.api-consumer-experience.outcomes.3": "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)", "station.api-platform-architecture.outcomes.1": "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "station.api-platform-architecture.outcomes.2": "Design für interne Wiederverwendung und externe Skalierbarkeit", "station.api-platform-architecture.how_it_works.1": "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "station.api-platform-architecture.how_it_works.2": "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "station.api-platform-architecture.how_it_works.3": "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "station.api-design.outcomes.1": "Wiederverwendbare und validierte Schnittstellenverträge", "station.api-design.outcomes.2": "Entwürfe, die auf Domänenmodelle und Interaktionsmuster abgestimmt sind", "station.api-design.outcomes.3": "Rückverfolgbarkeit des Designs zum Geschäftswert", "station.api-design.how_it_works.1": "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "station.api-design.how_it_works.2": "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "station.api-design.how_it_works.3": "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "station.api-design.how_it_works.4": "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "station.api-design.how_it_works.5": "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "station.api-design.how_it_works.6": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "station.api-design.how_it_works.7": "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "station.api-delivery.outcomes.1": "Zuverlässige und automatisierte CI/CD-Pipelines", "station.api-delivery.outcomes.2": "Funktionale und nicht-funktionale Tests integriert", "station.api-delivery.outcomes.3": "Sichere und gesetzeskonforme Bereitstellungspipelines", "station.api-delivery.how_it_works.1": "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.", "station.api-delivery.how_it_works.2": "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "station.api-delivery.how_it_works.3": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "station.api-delivery.how_it_works.4": "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "station.api-delivery.how_it_works.5": "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.", "station.api-audit.outcomes.1": "Klare Dokumentation des API-Designs und der Implementierungsentscheidungen", "station.api-audit.outcomes.2": "Sicherheit, Leistung und Compliance validiert", "station.api-audit.outcomes.3": "Geringeres Risiko von Problemen in der Produktion", "station.api-audit.how_it_works.1": "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.", "station.api-audit.how_it_works.2": "Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.", "station.api-publishing.outcomes.1": "Klare API-Einführungs- und Registrierungsprozesse", "station.api-publishing.outcomes.2": "Dokumentation, Sicherheitsmodelle und Richtlinien verfügbar", "station.api-publishing.outcomes.3": "APIs bereit für Skalierung und Governance", "station.api-publishing.how_it_works.1": "Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.", "station.api-publishing.how_it_works.2": "Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.", "station.monitoring-and-improving.outcomes.1": "Feedback-Schleifen für Entwickler sind vorhanden", "station.monitoring-and-improving.outcomes.2": "Kontinuierlich ermittelte und behandelte Probleme", "station.monitoring-and-improving.outcomes.3": "Iteration der API, abgestimmt auf die Bedürfnisse der Nutzer", "station.monitoring-and-improving.how_it_works.1": "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.", "station.monitoring-and-improving.how_it_works.2": "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.", "station.user-experience.outcomes.1": "Intuitive und einheitliche Benutzeroberflächen", "station.user-experience.outcomes.2": "Nutzer-Feedback in API-Design integriert", "station.user-experience.outcomes.3": "Verbesserte Nutzerzufriedenheit und Akzeptanz", "station.user-experience.how_it_works.1": "Führen Sie Nutzerforschung durch, um Erkenntnisse darüber zu gewinnen, wie die Nutzer mit den Ökosystemdiensten oder Ihren API nutzenden Anwendungen interagieren.", "station.user-experience.how_it_works.2": "Dokumentieren Sie die Anforderungen an die Benutzererfahrung, damit sie beim API-Design verwendet werden können, um sicherzustellen, dass sie intuitiv und einfach zu bedienen sind.", "station.market-insights.outcomes.1": "Ermittlung von Industriestandards und bewährten Verfahren", "station.market-insights.outcomes.2": "API-Strategie auf die Bedürfnisse des Marktes abgestimmt", "station.market-insights.outcomes.3": "Fundierte Entscheidungsfindung auf der Grundlage von Marktkenntnissen", "station.market-insights.how_it_works.1": "Analysieren Sie die APIs der Mitbewerber, um deren Stärken, Schwächen und Alleinstellungsmerkmale zu verstehen.", "station.market-insights.how_it_works.2": "Ermittlung von Industriestandards und bewährten Verfahren, um sicherzustellen, dass APIs wettbewerbsfähig und konform sind.", "station.business-goals.outcomes.1": "Klarer Geschäftswert für jede API definiert", "station.business-goals.outcomes.2": "Akzeptanz und Unterstützung von API-Initiativen durch die Interessengruppen", "station.business-goals.outcomes.3": "APIs tragen zum Unternehmenserfolg bei", "station.business-goals.how_it_works.1": "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "station.business-goals.how_it_works.2": "Einbindung von Interessengruppen, um die Abstimmung und Unterstützung von API-Initiativen sicherzustellen.", "station.competitive-analysis.outcomes.1": "Möglichkeiten zur Differenzierung identifiziert", "station.competitive-analysis.outcomes.2": "API-Strategie auf der Grundlage von Erkenntnissen über den Wettbewerb", "station.competitive-analysis.outcomes.3": "Gesteigerte Wettbewerbsfähigkeit auf dem API-Markt", "station.competitive-analysis.how_it_works.1": "Identifizieren Sie Marktlücken, die Ihre APIs auf der Grundlage der Angebote der Wettbewerber füllen können.", "station.competitive-analysis.how_it_works.2": "Entwickeln Sie eine Differenzierungsstrategie, die die einzigartigen Merkmale und Vorteile Ihrer APIs hervorhebt.", "station.ecosystem-vision.outcomes.1": "APIs, die Zusammenarbeit und Integration ermöglichen", "station.ecosystem-vision.outcomes.2": "Identifizierung und Einbindung von Ökosystempartnern", "station.ecosystem-vision.outcomes.3": "APIs tragen zu einem lebendigen Ökosystem bei", "station.ecosystem-vision.how_it_works.1": "Identifizieren Sie die wichtigsten Ökosystempartner und -akteure, die von dem Ökosystem profitieren oder zu ihm beitragen werden.", "station.ecosystem-vision.how_it_works.2": "Entwicklung von APIs, die eine nahtlose Integration und Zusammenarbeit innerhalb des Ökosystems ermöglichen.", "station.scalable-infrastructure.outcomes.1": "Hohe Verfügbarkeit und Leistung unter Last", "station.scalable-infrastructure.outcomes.2": "Eine für künftiges Wachstum ausgelegte Infrastruktur", "station.scalable-infrastructure.outcomes.3": "Geringere Ausfallzeiten und verbesserte Benutzerfreundlichkeit", "station.scalable-infrastructure.how_it_works.1": "Implementierung von Lastausgleich, Caching und anderen Techniken, um hohe Verfügbarkeit und Leistung zu gewährleisten. Sammeln von Infrastrukturanforderungen von API-Teams mithilfe von Capacity Canvas", "station.scalable-infrastructure.how_it_works.2": "Überwachen Sie die Leistung und Kapazität der Infrastruktur, um sicherzustellen, dass sie die wachsende Nachfrage bewältigen kann.", "station.legal-and-compliance.outcomes.1": "Anforderungen an Datenschutz und Privatsphäre erfüllt", "station.legal-and-compliance.outcomes.2": "Ermittelte und abgemilderte rechtliche Risiken", "station.legal-and-compliance.outcomes.3": "Klare Dokumentation der Compliance-Maßnahmen", "station.legal-and-compliance.how_it_works.1": "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "station.legal-and-compliance.how_it_works.2": "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Nutzern mitgeteilt werden.", "station.security-and-privacy.outcomes.1": "Schutz der Nutzerdaten durch Maßnahmen zum Schutz der Privatsphäre", "station.security-and-privacy.outcomes.2": "Bewährte Sicherheitspraktiken bei der Gestaltung und Entwicklung von APIs", "station.security-and-privacy.outcomes.3": "Einhaltung von Sicherheitsstandards und -vorschriften", "station.security-and-privacy.how_it_works.1": "Gewährleistung des Datenschutzes für die Nutzer durch die Umsetzung von Datenschutzmaßnahmen wie Anonymisierung und Zugangskontrolle.", "station.security-and-privacy.how_it_works.2": "Durchführung regelmäßiger Sicherheitsaudits und Schwachstellenbewertungen zur Ermittlung und Minderung von Risiken.", "station.design-standards.outcomes.1": "Hochwertige APIs, die den Bedürfnissen der Nutzer entsprechen", "station.design-standards.outcomes.2": "Wiederverwendbare Entwurfsmuster und Komponenten", "station.design-standards.outcomes.3": "Verringerung von Designinkonsistenzen und technischen Schulden", "station.design-standards.how_it_works.1": "Erstellen Sie wiederverwendbare Entwurfsmuster und Komponenten, die von Teams genutzt werden können, um Konsistenz und Qualität zu gewährleisten.", "station.design-standards.how_it_works.2": "Durchführung von Entwurfsprüfungen und Audits, um die Einhaltung von Entwurfsstandards zu gewährleisten und verbesserungswürdige Bereiche zu ermitteln.", "station.vendor-management.outcomes.1": "Zuverlässig und sicher integrierte APIs von Drittanbietern", "station.vendor-management.outcomes.2": "Einhaltung der Organisationsstandards durch den Lieferanten", "station.vendor-management.outcomes.3": "Geringere Risiken im Zusammenhang mit Abhängigkeiten von Dritten", "station.vendor-management.how_it_works.1": "Definieren Sie Kriterien für die Bewertung von Anbieter-APIs, einschließlich Zuverlässigkeit, Sicherheit und Compliance.", "station.vendor-management.how_it_works.2": "Überwachung der Leistung von Anbietern und der Einhaltung von Service Level Agreements (SLAs) und Organisationsstandards.", "station.contract-design.outcomes.1": "Umriss der Erwartungen und Verantwortlichkeiten von API-Anbietern und Nutzern", "station.contract-design.outcomes.2": "Dokumentierte Verwendungsrichtlinien und bewährte Verfahren", "station.contract-design.outcomes.3": "Weniger Missverständnisse und Streitigkeiten über die API-Nutzung", "station.contract-design.how_it_works.1": "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare Schnittstellenverträge zu erstellen, die sich leicht austauschen und validieren lassen.", "station.contract-design.how_it_works.2": "Sicherstellen, dass die Schnittstellenverträge von den Beteiligten geprüft und genehmigt werden, um Übereinstimmung und Klarheit zu gewährleisten.", "station.development.outcomes.1": "Hochwertige, wartbare und skalierbare APIs", "station.development.outcomes.2": "Befolgung einheitlicher Kodierungsstandards und -praktiken", "station.development.outcomes.3": "Geringere Entwicklungszeit und weniger technische Schulden", "station.development.how_it_works.1": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass Schnittstellenverträge vor der Implementierung validiert werden.", "station.development.how_it_works.2": "Befolgen Sie Kodierungsstandards und bewährte Verfahren, um eine konsistente und hochwertige API-Entwicklung zu gewährleisten.", "station.ci-cd.outcomes.1": "Konsistente Qualität und Rückverfolgbarkeit bei der API-Lieferung", "station.ci-cd.outcomes.2": "Schnellere Iterationen und kürzere Markteinführungszeiten", "station.ci-cd.outcomes.3": "Verbesserte Zusammenarbeit und Feedback-Schleifen bei der API-Entwicklung", "station.ci-cd.how_it_works.1": "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "station.ci-cd.how_it_works.2": "Implementieren Sie automatisierte Sicherheitsprüfungen und Compliance-Validierungen in der CI/CD-Pipeline, um sicherzustellen, dass APIs sicher und konform sind.", "station.test-automation.outcomes.1": "Automatisierte Funktions-, Sicherheits- und Leistungstests", "station.test-automation.outcomes.2": "Reduzierter manueller Testaufwand und erhöhte Testabdeckung", "station.test-automation.outcomes.3": "Verbesserte Zuverlässigkeit und Qualität der API", "station.test-automation.how_it_works.1": "Implementierung von Testautomatisierungs-Frameworks, die Vertragstests, Integrationstests und End-to-End-Tests unterstützen.", "station.test-automation.how_it_works.2": "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "station.release-management.outcomes.1": "Festlegung von Versions- und Bereitstellungsstrategien", "station.release-management.outcomes.2": "Rollback-Verfahren für API-Releases eingeführt", "station.release-management.outcomes.3": "Geringere Risiken im Zusammenhang mit API-Änderungen", "station.release-management.how_it_works.1": "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "station.release-management.how_it_works.2": "Einführung von Rollback-Verfahren zur schnellen Rückgängigmachung von Änderungen im Falle von Problemen bei API-Releases.", "station.service-agreements.outcomes.1": "Erwartungen und Dienstleistungsniveaus für API-Anbieter und Nutzer", "station.service-agreements.outcomes.2": "Zuständigkeiten und Unterstützungsprozesse dokumentiert", "station.service-agreements.outcomes.3": "Verbesserte Kommunikation und Zusammenarbeit zwischen API-Teams", "station.service-agreements.how_it_works.1": "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "station.service-agreements.how_it_works.2": "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten.", "station.api-consumer-adoption.outcomes.1": "Erhöhte API-Nutzung und Engagement", "station.api-consumer-adoption.outcomes.2": "Nutzer werden über die Funktionen und Vorteile von APIs aufgeklärt", "station.api-consumer-adoption.outcomes.3": "Verbesserte Zufriedenheit und Loyalität der Nutzer", "station.api-consumer-adoption.how_it_works.1": "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "station.api-consumer-adoption.how_it_works.2": "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "station.api-promotion.outcomes.1": "Erhöhte Sichtbarkeit und Bekanntheit von API", "station.api-promotion.outcomes.2": "Höhere API-Nutzungs- und Akzeptanzraten", "station.api-promotion.outcomes.3": "Verbesserte Nutzerbindung und -zufriedenheit", "station.api-promotion.how_it_works.1": "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "station.api-promotion.how_it_works.2": "Engagieren Sie sich in API-Gemeinschaften und Foren, um API-Aktualisierungen weiterzugeben, Feedback zu sammeln und die API-Nutzung zu fördern.", "station.partner-integration.outcomes.1": "Verbesserte API-Funktionen durch Partner-APIs", "station.partner-integration.outcomes.2": "Erhöhte Reichweite und Marktchancen durch Partnerschaften", "station.partner-integration.outcomes.3": "Verbesserte Zusammenarbeit und Innovation mit Partnern", "station.partner-integration.how_it_works.1": "Festlegung von Integrationsprozessen und Richtlinien für die Zusammenarbeit mit Partnern, einschließlich technischer Integration, Datenaustausch und Unterstützung.", "station.partner-integration.how_it_works.2": "Überwachen Sie die API-Leistung und -Einhaltung der Partner, um Zuverlässigkeit und Übereinstimmung mit Ihrer API-Strategie zu gewährleisten.", "station.api-mindset.outcomes.1": "Verbesserte Innovation und Zusammenarbeit durch APIs", "station.api-mindset.outcomes.2": "API-Teams, die in der Lage sind, die API-Strategie und -Initiativen voranzutreiben", "station.api-mindset.outcomes.3": "Verbesserte Abstimmung zwischen Geschäftszielen und API-Entwicklung", "station.api-mindset.how_it_works.1": "Fördern Sie die funktionsübergreifende Zusammenarbeit zwischen API-Teams, Geschäftseinheiten und Interessenvertretern, um API-Initiativen mit den Geschäftszielen abzustimmen.", "station.api-mindset.how_it_works.2": "Bereitstellung von Schulungen und Ressourcen, um Teams dabei zu helfen, eine API-first-Mentalität zu entwickeln und die Vorteile von APIs zu verstehen.", "station.roles-and-responsibilities.outcomes.1": "Effektive Zusammenarbeit und Verantwortlichkeit innerhalb der API-Teams", "station.roles-and-responsibilities.outcomes.2": "Verbesserte Kommunikation und Abstimmung zwischen den Teammitgliedern", "station.roles-and-responsibilities.outcomes.3": "Weniger Verwirrung und Überschneidungen bei den Zuständigkeiten", "station.roles-and-responsibilities.how_it_works.1": "Legen Sie klare Verantwortlichkeiten für jede Rolle fest, einschließlich API-Design, Entwicklung, Testen und Betrieb.", "station.roles-and-responsibilities.how_it_works.2": "Sicherstellen, dass die Rollen und Verantwortlichkeiten allen Teammitgliedern und Interessenvertretern mitgeteilt werden, um eine Abstimmung zu gewährleisten.", "station.upskilling.outcomes.1": "Erhöhte Kompetenz bei der Konzeption, Entwicklung und Verwaltung von APIs", "station.upskilling.outcomes.2": "Verbesserte Fähigkeit zur Übernahme neuer Technologien und Verfahren", "station.upskilling.outcomes.3": "Befähigte Teams zur Förderung von API-Innovation und -Qualität", "station.operating-guidelines.outcomes.1": "Konsistente API-Verwaltung und -Qualität im gesamten Unternehmen", "station.operating-guidelines.outcomes.2": "Einhaltung von Organisationsstandards und bewährten Verfahren", "station.operating-guidelines.outcomes.3": "Verbesserte Sichtbarkeit und Kontrolle über API-Initiativen", "station.operating-guidelines.how_it_works.1": "Etablieren Sie Governance-Praktiken, die sicherstellen, dass APIs einheitlich verwaltet werden, einschließlich Überprüfungen, Audits und Compliance-Checks.", "station.operating-guidelines.how_it_works.2": "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten", "station.portfolio-management.outcomes.1": "APIs im Einklang mit Unternehmenszielen und strategischen Initiativen", "station.portfolio-management.outcomes.2": "Priorisierung und Optimierung von APIs auf der Grundlage von Wert und Wirkung", "station.portfolio-management.outcomes.3": "Verbesserte Sichtbarkeit und Kontrolle über das API-Portfolio", "station.budget-and-resource-management.outcomes.1": "Effiziente Zuweisung von Ressourcen für API-Initiativen", "station.budget-and-resource-management.outcomes.2": "Optimierte Investitionen in die API-Entwicklung und -Verwaltung", "station.budget-and-resource-management.outcomes.3": "Verbesserte finanzielle Transparenz und Kontrolle über API-Initiativen", "cycle.api-productization-cycle.station.api-product-strategy.title": "API-Produktstrategie - APIs in strategische Produkte verwandeln", "cycle.api-productization-cycle.station.api-product-strategy.why_it_matters": "Viele Unternehmen betrachten APIs als technische Projekte und nicht als Produkte. Das Ergebnis? Verwirrte Kunden, schlechte Akzeptanz und verschwendeter Aufwand.\n\nDiese 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.", "cycle.api-productization-cycle.station.api-product-strategy.apply_in_work": "Bereitstellung von Richtlinien und Vorlagen für die Erstellung von API-Geschäftsmodellen, Wertvorschlägen und Roadmaps.", "cycle.api-productization-cycle.station.api-product-strategy.outcomes": "Ein klares API-Wertversprechen und eine klare Zielgruppe", "cycle.api-productization-cycle.station.api-product-strategy.how_it_works": "Untersuchen Sie das Kunden- oder Partnerproblem, das Sie mit APIs lösen wollen. Zeichnen Sie die Stakeholder, deren Wege und Ergebnisse mithilfe der Customer Journey Canvas auf.", "cycle.api-productization-cycle.station.api-product-strategy.outcomes.1": "Gemeinsame Sprache zwischen Produkt, Design und Technik", "cycle.api-productization-cycle.station.api-product-strategy.outcomes.2": "Ein solides Argument für die Finanzierung/Bewilligung", "cycle.api-productization-cycle.station.api-product-strategy.how_it_works.1": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "cycle.api-productization-cycle.station.api-product-strategy.how_it_works.2": "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "cycle.api-productization-cycle.station.api-product-strategy.how_it_works.3": "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "cycle.api-productization-cycle.station.api-consumer-experience.title": "API Consumer Experience - Design für die echten Benutzer Ihrer API", "cycle.api-productization-cycle.station.api-consumer-experience.why_it_matters": "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.\n\nOhne einen klaren Erlebnisplan:\n- Großartige APIs bleiben ungenutzt\n- Teams verschwenden Zeit damit, zu raten, wie sie Ihre API verwenden sollen\n- Feedbackschleifen sind unterbrochen oder fehlen.\n\nDiese Station hilft Ihnen, Ihre API mit den Augen ihrer Nutzer zu sehen.", "cycle.api-productization-cycle.station.api-consumer-experience.how_it_works": "Überprüfen Sie das bestehende API Value Proposition Canvаs von der Perspektive des Nutzers. Stellen Sie die Stabilität der unterstützten Geschäftsprozesse sicher und ergänzen Sie die Funktionen, die Probleme lösen und Vorteile bieten, um die Bedürfnisse der Nutzer zu berücksichtigen, damit diese spätere Designentscheidungen leiten können.", "cycle.api-productization-cycle.station.api-consumer-experience.how_it_works.1": "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "cycle.api-productization-cycle.station.api-consumer-experience.how_it_works.2": "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "cycle.api-productization-cycle.station.api-consumer-experience.apply_in_work": "Bereitstellung von Richtlinien, Tools und Feedback-Mechanismen für das Verständnis, die Analyse und die Verbesserung der internen und externen Erfahrungen von Entwicklern und Partnern.", "cycle.api-productization-cycle.station.api-consumer-experience.outcomes": "Identifizieren und priorisieren Sie Ihre Nutzer", "cycle.api-productization-cycle.station.api-consumer-experience.outcomes.1": "Definieren Sie die API-Erlebnisreise", "cycle.api-productization-cycle.station.api-consumer-experience.outcomes.2": "Onboarding, Dokumentation und Feedback planen", "cycle.api-productization-cycle.station.api-consumer-experience.outcomes.3": "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)", "cycle.api-productization-cycle.station.api-platform-architecture.title": "API-Plattformarchitektur - Architektur von APIs für Skalierbarkeit und Wiederverwendung", "cycle.api-productization-cycle.station.api-platform-architecture.why_it_matters": "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.", "cycle.api-productization-cycle.station.api-platform-architecture.apply_in_work": "Aufbau einer skalierbaren, sicheren und konformen Infrastruktur für den API-Betrieb. Bereitstellung von Leitlinien für bewährte Architekturverfahren.", "cycle.api-productization-cycle.station.api-platform-architecture.outcomes": "Redundante APIs abbauen und die Kosten für die Cloud-Plattform senken", "cycle.api-productization-cycle.station.api-platform-architecture.how_it_works": "Das Business Impact Canvas hilft dabei, Risiken in Bezug auf API-Verfügbarkeit, -Sicherheit und -Funktionalität zu identifizieren und zu mindern, um fundierte Architekturentscheidungen zu unterstützen.", "cycle.api-productization-cycle.station.api-platform-architecture.outcomes.1": "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "cycle.api-productization-cycle.station.api-platform-architecture.outcomes.2": "Design für interne Wiederverwendung und externe Skalierbarkeit", "cycle.api-productization-cycle.station.api-platform-architecture.how_it_works.1": "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "cycle.api-productization-cycle.station.api-platform-architecture.how_it_works.2": "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "cycle.api-productization-cycle.station.api-platform-architecture.how_it_works.3": "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "cycle.api-productization-cycle.station.api-design.title": "API-Design - Entwerfen Sie APIs, die Wert liefern", "cycle.api-productization-cycle.station.api-design.why_it_matters": "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.", "cycle.api-productization-cycle.station.api-design.apply_in_work": "Bereitstellung von wiederverwendbaren Designmustern, gemeinsamen Standards und Validierungstools für API-Spezifikationen. Sicherstellen, dass Designentscheidungen konsistent, frühzeitig überprüft und auf die Geschäftsabsicht ausgerichtet sind.", "cycle.api-productization-cycle.station.api-design.outcomes": "Gut dokumentierte und konsistente API-Designs", "cycle.api-productization-cycle.station.api-design.how_it_works": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen.", "cycle.api-productization-cycle.station.api-design.outcomes.1": "Wiederverwendbare und validierte API-Schnittstellenverträge", "cycle.api-productization-cycle.station.api-design.outcomes.2": "Entwürfe, die auf Domänenmodelle und Interaktionsmuster abgestimmt sind", "cycle.api-productization-cycle.station.api-design.outcomes.3": "Rückverfolgbarkeit des Designs zum Geschäftswert", "cycle.api-productization-cycle.station.api-design.how_it_works.1": "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "cycle.api-productization-cycle.station.api-design.how_it_works.2": "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "cycle.api-productization-cycle.station.api-design.how_it_works.3": "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "cycle.api-productization-cycle.station.api-design.how_it_works.4": "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "cycle.api-productization-cycle.station.api-design.how_it_works.5": "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "cycle.api-productization-cycle.station.api-design.how_it_works.6": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den API-Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "cycle.api-productization-cycle.station.api-design.how_it_works.7": "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "cycle.api-productization-cycle.station.api-delivery.title": "API-Bereitstellung - Bereitstellung sicherer und zuverlässiger APIs", "cycle.api-productization-cycle.station.api-delivery.why_it_matters": "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.", "cycle.api-productization-cycle.station.api-delivery.apply_in_work": "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.", "cycle.api-productization-cycle.station.api-delivery.outcomes": "APIs, die mit getesteten Frameworks und Mustern implementiert werden", "cycle.api-productization-cycle.station.api-delivery.how_it_works": "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.", "cycle.api-productization-cycle.station.api-delivery.outcomes.1": "Zuverlässige und automatisierte CI/CD-Pipelines", "cycle.api-productization-cycle.station.api-delivery.outcomes.2": "Funktionale und nicht-funktionale Tests integriert", "cycle.api-productization-cycle.station.api-delivery.outcomes.3": "Sichere und gesetzeskonforme Bereitstellungspipelines", "cycle.api-productization-cycle.station.api-delivery.how_it_works.1": "Erstellen Sie die API-Implementierung auf Basis des validierten Schnittstellenvertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.", "cycle.api-productization-cycle.station.api-delivery.how_it_works.2": "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "cycle.api-productization-cycle.station.api-delivery.how_it_works.3": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "cycle.api-productization-cycle.station.api-delivery.how_it_works.4": "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "cycle.api-productization-cycle.station.api-delivery.how_it_works.5": "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.", "cycle.api-productization-cycle.station.api-audit.title": "API-Audit - Prüfung von APIs auf Compliance und Qualität", "cycle.api-productization-cycle.station.api-audit.why_it_matters": "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.", "cycle.api-productization-cycle.station.api-audit.apply_in_work": "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.", "cycle.api-productization-cycle.station.api-audit.outcomes": "APIs erfüllen interne und externe Standards", "cycle.api-productization-cycle.station.api-audit.how_it_works": "Führen Sie Audits durch, um sicherzustellen, dass APIs vor der Veröffentlichung organisatorische, technische und rechtliche Standards erfüllen.", "cycle.api-productization-cycle.station.api-audit.outcomes.1": "Klare Dokumentation des API-Designs und der Implementierungsentscheidungen", "cycle.api-productization-cycle.station.api-audit.outcomes.2": "Sicherheit, Leistung und Compliance validiert", "cycle.api-productization-cycle.station.api-audit.outcomes.3": "Geringeres Risiko von Problemen in der Produktion", "cycle.api-productization-cycle.station.api-audit.how_it_works.1": "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.", "cycle.api-productization-cycle.station.api-audit.how_it_works.2": "Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.", "cycle.api-productization-cycle.station.api-publishing.title": "API-Veröffentlichung - Veröffentlichen Sie APIs mit Zuversicht", "cycle.api-productization-cycle.station.api-publishing.why_it_matters": "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.", "cycle.api-productization-cycle.station.api-publishing.apply_in_work": "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.", "cycle.api-productization-cycle.station.api-publishing.outcomes": "Veröffentlichung von APIs in der richtigen Umgebung (privat, Partner, öffentlich)", "cycle.api-productization-cycle.station.api-publishing.how_it_works": "Veröffentlichen Sie APIs in den entsprechenden Gateways und Umgebungen, um die Wiederverwendbarkeit für mehrere Nutzer zu unterstützen.", "cycle.api-productization-cycle.station.api-publishing.outcomes.1": "Klare API-Einführungs- und Registrierungsprozesse", "cycle.api-productization-cycle.station.api-publishing.outcomes.2": "Dokumentation, Sicherheitsmodelle und Richtlinien verfügbar", "cycle.api-productization-cycle.station.api-publishing.outcomes.3": "APIs bereit für Skalierung und Governance", "cycle.api-productization-cycle.station.api-publishing.how_it_works.1": "Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.", "cycle.api-productization-cycle.station.api-publishing.how_it_works.2": "Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.", "cycle.api-productization-cycle.station.monitoring-and-improving.title": "Überwachen und Verbessern - für den API-Wert", "cycle.api-productization-cycle.station.monitoring-and-improving.why_it_matters": "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.", "cycle.api-productization-cycle.station.monitoring-and-improving.apply_in_work": "Einrichtung von Analyserahmen zur Verfolgung von Leistung und Engagement. Entwickeln Sie Feedbackschleifen, Analysetools und Engagementstrategien für APIs.", "cycle.api-productization-cycle.station.monitoring-and-improving.outcomes": "Festlegung und Verfolgung von Leistungs- und Nutzungskennzahlen", "cycle.api-productization-cycle.station.monitoring-and-improving.how_it_works": "Überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Akzeptanzmetriken (z. B. NPS).", "cycle.api-productization-cycle.station.monitoring-and-improving.outcomes.1": "Feedback-Schleifen für Entwickler sind vorhanden", "cycle.api-productization-cycle.station.monitoring-and-improving.outcomes.2": "Kontinuierlich ermittelte und behandelte Probleme", "cycle.api-productization-cycle.station.monitoring-and-improving.outcomes.3": "Iteration der API, abgestimmt auf die Bedürfnisse der Nutzer", "cycle.api-productization-cycle.station.monitoring-and-improving.how_it_works.1": "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.", "cycle.api-productization-cycle.station.monitoring-and-improving.how_it_works.2": "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.", "resource.api-community-engagement-strategies.title": "Strategien für das Engagement der API-Gemeinschaft", "resource.api-community-engagement-strategies.description": "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.", "resource.api-community-engagement-strategies.outcomes": "Besseres Verständnis der Grundsätze von Strategien zur Einbindung der API-Gemeinschaft", "resource.api-community-engagement-strategies.steps": "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "resource.api-community-engagement-strategies.tips": "Passen Sie die API Community Engagement-Strategien für Ihren Bereich an", "resource.api-compliance-best-practices.title": "Bewährte Praktiken zur API-Einhaltung", "resource.api-compliance-best-practices.description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "resource.api-compliance-best-practices.outcomes": "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "resource.api-compliance-best-practices.steps": "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "resource.api-compliance-best-practices.tips": "Passen Sie die API-Compliance-Best Practices für Ihre Domäne an", "resource.api-development-best-practices.title": "Bewährte Praktiken der API-Entwicklung", "resource.api-development-best-practices.description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "resource.api-development-best-practices.outcomes": "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "resource.api-development-best-practices.steps": "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "resource.api-development-best-practices.tips": "Verwenden Sie diese Ressource als Implementierungsleitfaden und als Bewertungsinstrument und nicht als obligatorisches eigenständiges Artefakt", "resource.api-metrics-and-analytics.title": "API-Metriken und -Analysen", "resource.api-metrics-and-analytics.description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "resource.api-metrics-and-analytics.outcomes": "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "resource.api-metrics-and-analytics.steps": "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "resource.api-metrics-and-analytics.tips": "Anpassen der API-Metriken und -Analysen für Ihren Bereich", "resource.api-onboarding-best-practices.title": "Bewährte Praktiken beim API-Onboarding", "resource.api-onboarding-best-practices.description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "resource.api-onboarding-best-practices.outcomes": "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "resource.api-onboarding-best-practices.steps": "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "resource.api-onboarding-best-practices.tips": "Passen Sie die API Onboarding Best Practices für Ihren Bereich an", "resource.api-portfolio-management-guidelines.title": "Leitlinien für das API-Portfolio-Management", "resource.api-portfolio-management-guidelines.description": "Ein Leitfaden für die strategische Verwaltung der API-Suite eines Unternehmens - Priorisierung von APIs, Zuweisung von Ressourcen und Überwachung der Leistung über den gesamten Lebenszyklus.", "resource.api-portfolio-management-guidelines.outcomes": "Besseres Verständnis der Grundsätze der API-Portfolioverwaltung", "resource.api-portfolio-management-guidelines.steps": "Definition von Portfoliomanagementverfahren, die die Prozesse zur Verwaltung des API-Portfolios, einschließlich Priorisierung, Überwachung und Optimierung, umreißen.", "resource.api-portfolio-management-guidelines.tips": "Passen Sie die API-Portfolio-Management-Richtlinien für Ihren Bereich an", "resource.api-security-best-practices.title": "Bewährte Praktiken für die API-Sicherheit", "resource.api-security-best-practices.description": "Eine Reihe praktikabler Kontrollen zur Sicherung von APIs, einschließlich Authentifizierung, Autorisierung, Verschlüsselung, Ratenbegrenzung und Konformitätsprüfungen auf Pipeline-Ebene.", "resource.api-security-best-practices.outcomes": "Besseres Verständnis der Grundsätze bewährter API-Sicherheitspraktiken", "resource.api-security-best-practices.steps": "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "resource.api-security-best-practices.tips": "Passen Sie die bewährten API-Sicherheitspraktiken für Ihre Domäne an", "resource.api-team-structure-guidelines.title": "Leitlinien für die API-Teamstruktur", "resource.api-team-structure-guidelines.description": "Organisatorische Anleitung zur Definition von Rollen und Verantwortlichkeiten innerhalb von API-Teams, um Klarheit, Zusammenarbeit und Verantwortlichkeit zu gewährleisten.", "resource.api-team-structure-guidelines.outcomes": "Besseres Verständnis der Grundsätze der API-Teamstruktur", "resource.api-team-structure-guidelines.steps": "Definieren Sie Teamstrukturen und Rollen für API-Teams, einschließlich API-Produktverantwortliche, Entwickler, Architekten und Betriebsleiter.", "resource.api-team-structure-guidelines.tips": "Anpassen der Richtlinien für die API-Teamstruktur für Ihren Bereich", "resource.api-testing-best-practices.title": "Bewährte Praktiken für API-Tests", "resource.api-testing-best-practices.description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "resource.api-testing-best-practices.outcomes": "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "resource.api-testing-best-practices.steps": "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "resource.api-testing-best-practices.tips": "Anpassen der bewährten Praktiken für API-Tests für Ihren Bereich", "resource.api-training-programs.title": "API-Schulungsprogramme", "resource.api-training-programs.description": "Eine Roadmap für die Weiterbildung von Teams mit strukturierten Lernpfaden für API-Design, Governance, Leistung und Sicherheit.", "resource.api-training-programs.outcomes": "Besseres Verständnis der Grundsätze von API-Schulungsprogrammen", "resource.api-training-programs.steps": "Identifizieren Sie wichtige API-Fähigkeiten und Wissensbereiche, die verbessert werden müssen, wie z. B. API-Design, Sicherheit und Leistung.", "resource.api-training-programs.tips": "Passen Sie die API-Schulungsprogramme für Ihren Bereich an", "resource.api-versioning-best-practices.title": "Bewährte Praktiken der API-Versionierung", "resource.api-versioning-best-practices.description": "Strategien für die Einführung, Pflege und Abschaffung von API-Versionen unter Wahrung der Abwärtskompatibilität und des Vertrauens der Verbraucher.", "resource.api-versioning-best-practices.outcomes": "Besseres Verständnis der Grundsätze für bewährte Verfahren der API-Versionierung", "resource.api-versioning-best-practices.steps": "Definieren Sie Versionsstrategien für APIs, um Änderungen zu verwalten und Abwärtskompatibilität zu gewährleisten.", "resource.api-versioning-best-practices.tips": "Anpassen der bewährten API-Versionierungspraktiken für Ihre Domäne", "resource.apiops-CI-CD-for-apis.title": "APIOps CI/CD für APIs", "resource.apiops-CI-CD-for-apis.description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "resource.apiops-CI-CD-for-apis.outcomes": "Besseres Verständnis der Grundsätze von CI/CD für APIs", "resource.apiops-CI-CD-for-apis.steps": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "resource.apiops-CI-CD-for-apis.tips": "Passen Sie CI/CD For APIs für Ihren Bereich an", "resource.competitor-analysis-template.title": "Mitbewerber-Analyse Vorlage", "resource.competitor-analysis-template.description": "Ein strukturiertes Arbeitsblatt zum Benchmarking Ihres API-Angebots im Vergleich zu den Wettbewerbern, indem Stärken, Schwächen und Wertunterscheidungsmerkmale dargestellt werden.", "resource.competitor-analysis-template.outcomes": "Besseres Verständnis der Grundsätze für die Analyse von Wettbewerbern", "resource.competitor-analysis-template.steps": "Führen Sie eine Wettbewerbsanalyse durch, um die wichtigsten Wettbewerber und deren API-Angebote zu ermitteln.", "resource.competitor-analysis-template.tips": "Passen Sie die Vorlage für die Konkurrenzanalyse für Ihren Bereich an", "resource.contract-first-design.title": "Vertrag Erstes Design", "resource.contract-first-design.description": "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.", "resource.contract-first-design.outcomes": "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "resource.contract-first-design.steps": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "resource.contract-first-design.tips": "Passen Sie das Contract First Design für Ihre Domain an", "resource.cross-functional-collaboration-best-practices.title": "Best Practices für die funktionsübergreifende Zusammenarbeit", "resource.cross-functional-collaboration-best-practices.description": "Praktiken zur Erleichterung der Kommunikation und Abstimmung zwischen Geschäfts- und Technikerteams bei der Planung oder Bereitstellung von APIs.", "resource.cross-functional-collaboration-best-practices.outcomes": "Besseres Verständnis der Grundsätze der bewährten funktionsübergreifenden Zusammenarbeit", "resource.cross-functional-collaboration-best-practices.steps": "Fördern Sie die funktionsübergreifende Zusammenarbeit zwischen API-Teams, Geschäftseinheiten und Interessenvertretern, um API-Initiativen mit Geschäftszielen abzustimmen.", "resource.cross-functional-collaboration-best-practices.tips": "Passen Sie die Best Practices für die funktionsübergreifende Zusammenarbeit für Ihren Bereich an", "resource.data-privacy-guidelines.title": "Leitlinien zum Datenschutz", "resource.data-privacy-guidelines.description": "Designüberlegungen, um sicherzustellen, dass APIs durch Anonymisierung und Zugriffskontrollen Datenschutzbestimmungen wie GDPR erfüllen.", "resource.data-privacy-guidelines.outcomes": "Besseres Verständnis der Grundsätze der Datenschutzleitlinien", "resource.data-privacy-guidelines.steps": "Gewährleistung des Datenschutzes für die Nutzer durch die Umsetzung von Datenschutzmaßnahmen wie Anonymisierung und Zugangskontrolle.", "resource.data-privacy-guidelines.tips": "Passen Sie die Datenschutzrichtlinien für Ihren Bereich an", "resource.domain-canvas.title": "Domain Canvas", "resource.domain-canvas.description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "resource.domain-canvas.outcomes": "Besseres Verständnis der Grundsätze des Domain Canvas", "resource.domain-canvas.steps": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen.", "resource.domain-canvas.tips": "Anpassen des Domain Canvas für Ihre Domain", "resource.ecosystem-vision-template.title": "Ökosystem Vision Vorlage", "resource.ecosystem-vision-template.description": "Ein strategisches Planungsinstrument zur Definition des API-Ökosystems, einschließlich Zielpartnern, Wertschöpfungsketten und Integrationsmöglichkeiten.", "resource.ecosystem-vision-template.outcomes": "Besseres Verständnis der Grundsätze der Ökosystem-Vision-Vorlage", "resource.ecosystem-vision-template.steps": "Führen Sie Marktforschung durch, um Trends, Chancen und Bedrohungen in der API-Landschaft zu identifizieren.", "resource.ecosystem-vision-template.tips": "Passen Sie die Ecosystem Vision-Vorlage für Ihren Bereich an", "resource.industry-standards-and-best-practices.title": "Industriestandards und bewährte Praktiken", "resource.industry-standards-and-best-practices.description": "Eine Referenzressource für die Anpassung von API-Design und -Betrieb an weithin anerkannte Industrierahmenwerke und -spezifikationen.", "resource.industry-standards-and-best-practices.outcomes": "Besseres Verständnis der Industriestandards und der Grundsätze bewährter Verfahren", "resource.industry-standards-and-best-practices.steps": "Ermittlung von Industriestandards und bewährten Verfahren, um sicherzustellen, dass APIs wettbewerbsfähig und konform sind.", "resource.industry-standards-and-best-practices.tips": "Anpassung der Industriestandards und bewährten Praktiken für Ihren Bereich", "resource.partner-integration-guidelines.title": "Leitlinien für die Integration von Partnern", "resource.partner-integration-guidelines.description": "Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.", "resource.partner-integration-guidelines.outcomes": "Besseres Verständnis der Grundsätze der Leitlinien für die Integration von Partnern", "resource.partner-integration-guidelines.steps": "Festlegung von Integrationsprozessen und Richtlinien für die Zusammenarbeit mit Partnern, einschließlich technischer Integration, Datenaustausch und Unterstützung.", "resource.partner-integration-guidelines.tips": "Passen Sie die Partner-Integrationsrichtlinien für Ihre Domain an", "resource.role-communication-best-practices.title": "Bewährte Praktiken der Rollenkommunikation", "resource.role-communication-best-practices.description": "Werkzeuge, um zu definieren und zu dokumentieren, wer für was innerhalb von API-Initiativen verantwortlich ist, um sicherzustellen, dass Übergaben und Verantwortlichkeiten klar sind.", "resource.role-communication-best-practices.outcomes": "Besseres Verständnis der Grundsätze bewährter Praktiken der Rollenkommunikation", "resource.role-communication-best-practices.steps": "Legen Sie klare Verantwortlichkeiten für jede Rolle fest, einschließlich API-Design, Entwicklung, Testen und Betrieb.", "resource.role-communication-best-practices.tips": "Passen Sie die Best Practices für die Rollenkommunikation für Ihren Bereich an", "resource.scalable-infrastructure-best-practices.title": "Bewährte Praktiken für eine skalierbare Infrastruktur", "resource.scalable-infrastructure-best-practices.description": "Architektonische Anleitungen, um sicherzustellen, dass APIs in einer Infrastruktur bereitgestellt werden, die Nutzungsspitzen und Wachstum elastisch bewältigen kann.", "resource.scalable-infrastructure-best-practices.outcomes": "Besseres Verständnis der Grundsätze der bewährten Praktiken für skalierbare Infrastrukturen", "resource.scalable-infrastructure-best-practices.steps": "Entwerfen Sie eine skalierbare und robuste API-Infrastruktur unter Verwendung von Cloud-nativen Mustern und Technologien.", "resource.scalable-infrastructure-best-practices.tips": "Passen Sie die Best Practices für skalierbare Infrastrukturen an Ihren Bereich an", "resource.service-agreement-template.title": "Vorlage für eine Dienstleistungsvereinbarung", "resource.service-agreement-template.description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "resource.service-agreement-template.outcomes": "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "resource.service-agreement-template.steps": "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "resource.service-agreement-template.tips": "Passen Sie die Servicevertragsvorlage für Ihre Domain an", "resource.stakeholder-engagement-best-practices.title": "Bewährte Praktiken zur Einbindung von Stakeholdern", "resource.stakeholder-engagement-best-practices.description": "Einbindungstaktiken für die Ausrichtung interner und externer Interessengruppen auf gemeinsame API-Ziele, -Wert und -Governance.", "resource.stakeholder-engagement-best-practices.outcomes": "Besseres Verständnis der Grundsätze bewährter Verfahren für die Einbeziehung von Stakeholdern", "resource.stakeholder-engagement-best-practices.steps": "Einbindung von Interessengruppen, um die Abstimmung und Unterstützung von API-Initiativen sicherzustellen.", "resource.stakeholder-engagement-best-practices.tips": "Passen Sie die Best Practices für das Stakeholder-Engagement für Ihren Bereich an", "resource.test-automation-frameworks.title": "Testautomatisierungs-Frameworks", "resource.test-automation-frameworks.description": "Empfohlene Tools und Muster für die Automatisierung von API-Vertrags-, Regressions- und Integrationstests in verschiedenen Umgebungen.", "resource.test-automation-frameworks.outcomes": "Besseres Verständnis der Grundsätze von Testautomatisierungssystemen", "resource.test-automation-frameworks.steps": "Implementierung von Testautomatisierungs-Frameworks, die Vertragstests, Integrationstests und End-to-End-Tests unterstützen.", "resource.test-automation-frameworks.tips": "Passen Sie die Testautomatisierungs-Frameworks für Ihren Bereich an", "resource.vendor-management-best-practices.title": "Bewährte Praktiken im Lieferantenmanagement", "resource.vendor-management-best-practices.description": "Rahmen für die Bewertung und Verwaltung von externen API-Anbietern und Integrationen von Drittanbietern auf der Grundlage von Risiko, Leistung und Compliance.", "resource.vendor-management-best-practices.outcomes": "Besseres Verständnis der Grundsätze für bewährte Praktiken im Lieferantenmanagement", "resource.vendor-management-best-practices.steps": "Einrichtung von Prozessen zur Verwaltung von Anbietern, um Drittanbieter von APIs zu bewerten, einzubinden und zu überwachen.", "resource.vendor-management-best-practices.tips": "Passen Sie die Best Practices für das Lieferantenmanagement für Ihren Bereich an", "resource.api-audit-checklist.title": "API Audit Checkliste", "resource.api-audit-checklist.description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "resource.api-audit-checklist.outcomes": "Besseres Verständnis der Grundsätze der API Audit Checkliste", "resource.api-audit-checklist.steps": "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "resource.api-audit-checklist.tips": "Jeder Audit-Punkt verknüpft Lebenszyklus-Arbeitsschritte (Stationen), maßgebliche Richtlinien und unterstützende Nachweise, um einen klaren Überblick über die API-Bereitschaft zu bieten.", "resource.api-business-model-canvas.title": "API Business Model Canvas", "resource.api-business-model-canvas.description": "Strategische Bewertung der API-Geschäftsfähigkeit durch Zuordnung von Wertangeboten, Kundensegmenten und Schlüsselressourcen.", "resource.api-business-model-canvas.outcomes": "Klare Geschäftsstrategie für APIs", "resource.api-business-model-canvas.steps": "Fassen Sie das Wertversprechen der API zusammen", "resource.api-business-model-canvas.tips": "Beginnen Sie mit einer einzigen API, um Klarheit zu schaffen", "resource.api-design-principles.title": "API Design Prinzipien", "resource.api-design-principles.description": "Ein prägnanter Leitfaden zu API-Benutzerfreundlichkeit, Auffindbarkeit und Konsistenz, der auf gemeinsamen Designregeln und echten Kundenbedürfnissen basiert.", "resource.api-design-principles.outcomes": "Besseres Verständnis der API-Gestaltungsgrundsätze", "resource.api-design-principles.steps": "**Consumer-first design:** Wir beginnen jeden APIOps-Zyklus mit der Erfassung von Benutzerzielen und Fachbegriffen, damit APIs echte Probleme lösen.", "resource.api-design-principles.tips": "Anpassen der API-Entwurfsprinzipien für Ihre Domäne", "resource.api-value-proposition-canvas.title": "API Value Proposition Canvas", "resource.api-value-proposition-canvas.description": "Richten Sie API-Funktionen an den Bedürfnissen der Benutzer aus, indem Sie Aufgaben, Schmerzen und Gewinne auf API-Produkte abbilden.", "resource.api-value-proposition-canvas.outcomes": "Fokussierte Funktionsentwicklung", "resource.api-value-proposition-canvas.steps": "Aufgaben der Benutzerreise auflisten", "resource.api-value-proposition-canvas.tips": "Verwenden Sie den Input aus dem Customer Journey Canvas", "resource.business-impact-canvas.title": "Business Impact Canvas", "resource.business-impact-canvas.description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "resource.business-impact-canvas.outcomes": "Skalierbare API-Infrastruktur", "resource.business-impact-canvas.steps": "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "resource.business-impact-canvas.tips": "Architekten und Entwickler in den Entwurfsprozess einbeziehen", "resource.capacity-canvas.title": "Capacity Canvas", "resource.capacity-canvas.description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "resource.capacity-canvas.outcomes": "Anpassung der API-Kapazität an das Geschäftsvolumen", "resource.capacity-canvas.steps": "Dokumentieren Sie das aktuelle Geschäftsvolumen", "resource.capacity-canvas.tips": "Verwendung von Analysen zur Prognose von Wachstumstrends", "resource.customer-journey-canvas.title": "Customer Journey Canvas", "resource.customer-journey-canvas.description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "resource.customer-journey-canvas.outcomes": "Verbessertes Kundenverständnis", "resource.customer-journey-canvas.steps": "Kunden-Persona definieren", "resource.customer-journey-canvas.tips": "Iterieren Sie mit dem Input des Teams, um die Schritte zu verfeinern", "resource.event-canvas.title": "Event Canvas", "resource.event-canvas.description": "Entwerfen Sie ereignisgesteuerte APIs, indem Sie Ereignisse, Auslöser und Verarbeitungslogik definieren.", "resource.event-canvas.outcomes": "Definierte ereignisgesteuerte Architektur", "resource.event-canvas.steps": "Identifizierung von Schlüsselereignissen im System", "resource.event-canvas.tips": "Verwendung von Ereignisschemata zur Standardisierung von Ereignisformaten", "resource.graphql-canvas.title": "GraphQL Canvas", "resource.graphql-canvas.description": "Entwerfen Sie GraphQL-APIs, indem Sie Typen, Abfragen, Mutationen und Abonnements definieren.", "resource.graphql-canvas.outcomes": "Strukturierter GraphQL-API-Entwurf", "resource.graphql-canvas.steps": "Welche Probleme versuchen die API-Kunden zu lösen? Welche Daten benötigen sie?", "resource.graphql-canvas.tips": "Introspektion zur Validierung von Typdefinitionen verwenden", "resource.interaction-canvas.title": "Interaction Canvas", "resource.interaction-canvas.description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "resource.interaction-canvas.outcomes": "Klare API-Interaktionsabläufe", "resource.interaction-canvas.steps": "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "resource.interaction-canvas.tips": "Beginnen Sie mit allgemeinen Anwendungsfällen, bevor Sie sich mit Sonderfällen befassen", "resource.location-canvas.title": "Location Canvas", "resource.location-canvas.description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "resource.location-canvas.outcomes": "Einhaltung der örtlichen Vorschriften", "resource.location-canvas.steps": "Karte der Standorte von API-Anbietern.", "resource.location-canvas.tips": "Zusammenarbeit mit Rechts- und Compliance-Teams", "resource.rest-canvas.title": "REST Canvas", "resource.rest-canvas.description": "Entwurf von APIs unter Verwendung von RESTful-Prinzipien, Definition von Ressourcen, Verben und Beispielanforderungen und -antworten.", "resource.rest-canvas.outcomes": "Einheitliches RESTful API-Design", "resource.rest-canvas.steps": "Identifizierung der wichtigsten Ressourcen, die von der API bereitgestellt werden", "resource.rest-canvas.tips": "Verwendung von Standard-HTTP-Methoden (GET, POST, PUT, DELETE)", "resource.api-community-engagement-strategies.outcomes.1": "Standardisierter Ansatz mit API-Strategien zur Einbindung der Gemeinschaft", "resource.api-community-engagement-strategies.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-community-engagement-strategies.steps.1": "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "resource.api-community-engagement-strategies.steps.2": "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "resource.api-community-engagement-strategies.steps.3": "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "resource.api-community-engagement-strategies.steps.4": "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.", "resource.api-community-engagement-strategies.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-compliance-best-practices.outcomes.1": "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "resource.api-compliance-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-compliance-best-practices.steps.1": "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "resource.api-compliance-best-practices.steps.2": "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen.", "resource.api-compliance-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-development-best-practices.outcomes.1": "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "resource.api-development-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-development-best-practices.steps.1": "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren.", "resource.api-development-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-metrics-and-analytics.outcomes.1": "Standardisierter Ansatz mit API Metrics And Analytics", "resource.api-metrics-and-analytics.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-metrics-and-analytics.steps.1": "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "resource.api-metrics-and-analytics.steps.2": "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten", "resource.api-metrics-and-analytics.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-onboarding-best-practices.outcomes.1": "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "resource.api-onboarding-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-onboarding-best-practices.steps.1": "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "resource.api-onboarding-best-practices.steps.2": "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.", "resource.api-onboarding-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-portfolio-management-guidelines.outcomes.1": "Standardisierter Ansatz mit API-Portfolio-Management-Leitlinien", "resource.api-portfolio-management-guidelines.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-portfolio-management-guidelines.steps.1": "Definieren Sie Budget- und Ressourcenverwaltungspraktiken, die die Prozesse für die Verwaltung von Budgets und Ressourcen für API-Initiativen umreißen.", "resource.api-portfolio-management-guidelines.steps.2": "Festlegung von Kriterien für die Bewertung und Priorisierung von Budgetzuweisungen auf der Grundlage des Geschäftswerts, der Auswirkungen und der Ausrichtung auf strategische Initiativen.", "resource.api-portfolio-management-guidelines.steps.3": "Überwachen Sie das API-Portfolio, um sicherzustellen, dass die APIs einen Mehrwert liefern, die Leistungserwartungen erfüllen und mit den Geschäftszielen übereinstimmen.", "resource.api-portfolio-management-guidelines.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-security-best-practices.outcomes.1": "Standardisierter Ansatz mit bewährten API-Sicherheitspraktiken", "resource.api-security-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-security-best-practices.steps.1": "Implementieren Sie Sicherheitsmaßnahmen wie Authentifizierung, Autorisierung, Verschlüsselung und Ratenbegrenzung, um APIs vor Bedrohungen zu schützen.", "resource.api-security-best-practices.steps.2": "Implementieren Sie automatisierte Sicherheitsprüfungen und Compliance-Validierungen in der CI/CD-Pipeline, um sicherzustellen, dass APIs sicher und konform sind.", "resource.api-security-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-team-structure-guidelines.outcomes.1": "Standardisierter Ansatz unter Verwendung der API-Teamstruktur-Richtlinien", "resource.api-team-structure-guidelines.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-team-structure-guidelines.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-testing-best-practices.outcomes.1": "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "resource.api-testing-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-testing-best-practices.steps.1": "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "resource.api-testing-best-practices.steps.2": "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren.", "resource.api-testing-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-training-programs.outcomes.1": "Standardisierter Ansatz mit API-Schulungsprogrammen", "resource.api-training-programs.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-training-programs.steps.1": "Fördern Sie das kontinuierliche Lernen durch Online-Kurse, Zertifizierungen und Engagement in der Gemeinschaft.", "resource.api-training-programs.steps.2": "Bereitstellung von Schulungen und Ressourcen, um Teams dabei zu helfen, eine API-first-Mentalität zu entwickeln und die Vorteile von APIs zu verstehen.", "resource.api-training-programs.steps.3": "Bereitstellung von Schulungsprogrammen, Workshops und Ressourcen, um Teams bei der Verbesserung ihrer API-Fähigkeiten und -Kenntnisse zu unterstützen.", "resource.api-training-programs.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-versioning-best-practices.outcomes.1": "Standardisierter Ansatz mit bewährten Praktiken für die API-Versionierung", "resource.api-versioning-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-versioning-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.apiops-CI-CD-for-apis.outcomes.1": "Standardisierter Ansatz mit CI/CD für APIs", "resource.apiops-CI-CD-for-apis.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.apiops-CI-CD-for-apis.steps.1": "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "resource.apiops-CI-CD-for-apis.steps.2": "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "resource.apiops-CI-CD-for-apis.steps.3": "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.", "resource.apiops-CI-CD-for-apis.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.competitor-analysis-template.outcomes.1": "Standardisierter Ansatz unter Verwendung der Schablone für die Wettbewerberanalyse", "resource.competitor-analysis-template.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.competitor-analysis-template.steps.1": "Analysieren Sie die APIs der Mitbewerber, um deren Stärken, Schwächen und Alleinstellungsmerkmale zu verstehen.", "resource.competitor-analysis-template.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.contract-first-design.outcomes.1": "Standardisierter Ansatz mit Contract First Design", "resource.contract-first-design.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.contract-first-design.steps.1": "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "resource.contract-first-design.steps.2": "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen.", "resource.contract-first-design.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.cross-functional-collaboration-best-practices.outcomes.1": "Standardisierter Ansatz mit funktionsübergreifenden Best Practices für die Zusammenarbeit", "resource.cross-functional-collaboration-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.cross-functional-collaboration-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.data-privacy-guidelines.outcomes.1": "Standardisierter Ansatz mit Datenschutzrichtlinien", "resource.data-privacy-guidelines.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.data-privacy-guidelines.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.domain-canvas.outcomes.1": "Standardisierter Ansatz mit Domain Canvas", "resource.domain-canvas.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.domain-canvas.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.ecosystem-vision-template.outcomes.1": "Standardisierter Ansatz mit Ecosystem Vision Template", "resource.ecosystem-vision-template.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.ecosystem-vision-template.steps.1": "Identifizieren Sie die wichtigsten Ökosystempartner und -akteure, die von dem Ökosystem profitieren oder zu ihm beitragen werden.", "resource.ecosystem-vision-template.steps.2": "Identifizieren Sie Marktlücken, die Ihre APIs auf der Grundlage der Angebote der Wettbewerber füllen können.", "resource.ecosystem-vision-template.steps.3": "Identifizieren Sie potenzielle Partner, deren APIs Ihre API-Fähigkeiten und Ihr Wertversprechen verbessern können.", "resource.ecosystem-vision-template.steps.4": "Entwickeln Sie eine Differenzierungsstrategie, die die einzigartigen Merkmale und Vorteile Ihrer APIs hervorhebt.", "resource.ecosystem-vision-template.steps.5": "Definieren Sie die Vision des Ökosystems für Ihre APIs, einschließlich der Frage, wie sie mit anderen Systemen und Plattformen interagieren werden.", "resource.ecosystem-vision-template.steps.6": "Entwicklung von APIs, die eine nahtlose Integration und Zusammenarbeit innerhalb des Ökosystems ermöglichen.", "resource.ecosystem-vision-template.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.industry-standards-and-best-practices.outcomes.1": "Standardisierter Ansatz mit Industriestandards und Best Practices", "resource.industry-standards-and-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.industry-standards-and-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.partner-integration-guidelines.outcomes.1": "Standardisierter Ansatz unter Verwendung der Richtlinien zur Partnerintegration", "resource.partner-integration-guidelines.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.partner-integration-guidelines.steps.1": "Überwachen Sie die API-Leistung und -Einhaltung der Partner, um Zuverlässigkeit und Übereinstimmung mit Ihrer API-Strategie zu gewährleisten.", "resource.partner-integration-guidelines.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.role-communication-best-practices.outcomes.1": "Standardisierter Ansatz unter Verwendung von Best Practices für die Rollenkommunikation", "resource.role-communication-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.role-communication-best-practices.steps.1": "Sicherstellen, dass die Rollen und Verantwortlichkeiten allen Teammitgliedern und Interessenvertretern mitgeteilt werden, um eine Abstimmung zu gewährleisten.", "resource.role-communication-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.scalable-infrastructure-best-practices.outcomes.1": "Standardisierter Ansatz mit bewährten Praktiken für skalierbare Infrastrukturen", "resource.scalable-infrastructure-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.scalable-infrastructure-best-practices.steps.1": "Überwachen Sie die Leistung und Kapazität der Infrastruktur, um sicherzustellen, dass sie die wachsende Nachfrage bewältigen kann.", "resource.scalable-infrastructure-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.service-agreement-template.outcomes.1": "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "resource.service-agreement-template.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.service-agreement-template.steps.1": "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "resource.service-agreement-template.steps.2": "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten.", "resource.service-agreement-template.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.stakeholder-engagement-best-practices.outcomes.1": "Standardisierter Ansatz unter Verwendung von Best Practices für die Einbeziehung von Stakeholdern", "resource.stakeholder-engagement-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.stakeholder-engagement-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.test-automation-frameworks.outcomes.1": "Standardisierter Ansatz mit Testautomatisierungs-Frameworks", "resource.test-automation-frameworks.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.test-automation-frameworks.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.vendor-management-best-practices.outcomes.1": "Standardisierter Ansatz mit bewährten Praktiken für das Lieferantenmanagement", "resource.vendor-management-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.vendor-management-best-practices.steps.1": "Definieren Sie Kriterien für die Bewertung von Anbieter-APIs, einschließlich Zuverlässigkeit, Sicherheit und Compliance.", "resource.vendor-management-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-audit-checklist.outcomes.1": "Standardisierter Ansatz mit API Audit Checkliste", "resource.api-audit-checklist.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-audit-checklist.steps.1": "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "resource.api-audit-checklist.steps.2": "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind.", "resource.api-audit-checklist.tips.1": "Nutzen Sie die API-Audit-Checkliste gemeinsam in allen geschäftlichen und technischen Rollen", "resource.api-business-model-canvas.outcomes.1": "Identifizierung der wichtigsten Ressourcen und Partner", "resource.api-business-model-canvas.outcomes.2": "Abstimmung der API-Funktionen auf die Unternehmensziele", "resource.api-business-model-canvas.steps.1": "Definition von Verbrauchersegmenten", "resource.api-business-model-canvas.steps.2": "Ermittlung von Strategien für die Beziehungen zu Entwicklern", "resource.api-business-model-canvas.steps.3": "Karte der Vertriebskanäle", "resource.api-business-model-canvas.steps.4": "die wichtigsten Ressourcen und Aktivitäten zu dokumentieren", "resource.api-business-model-canvas.steps.5": "Ermittlung der wichtigsten Partner und Interessengruppen", "resource.api-business-model-canvas.steps.6": "Nutzen und Kosten aufzeigen", "resource.api-business-model-canvas.tips.1": "Verwendung von Metriken wie Kosten und Nutzen zur Priorisierung von Chancen", "resource.api-business-model-canvas.tips.2": "Validierung der Ergebnisse mit den wichtigsten Interessengruppen", "resource.api-design-principles.outcomes.1": "Standardisierter Ansatz mit API Design Prinzipien", "resource.api-design-principles.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken", "resource.api-design-principles.steps.1": "**Konsistente Benennung und Verhalten:** Anwendung gemeinsamer Konventionen für Ressourcen, Fehler und Formate, um APIs vorhersehbar zu machen.", "resource.api-design-principles.steps.2": "**Vertragsgesteuert:** Erfassen Sie die Schnittstelle mit OpenAPI oder AsyncAPI vor der Codierung, um die Teams aufeinander abzustimmen und Automatisierung zu ermöglichen.", "resource.api-design-principles.steps.3": "**Benutzerfreundlichkeit und Auffindbarkeit:** Bereitstellung einer klaren Dokumentation und von Beispielen, damit Entwickler schnell verstehen, wie die API zu verwenden ist.", "resource.api-design-principles.steps.4": "**Sicher iterieren:** Entwürfe in kleinen, abgestuften Schritten weiterentwickeln, damit Änderungen die bestehenden Kunden nicht stören.", "resource.api-design-principles.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen", "resource.api-value-proposition-canvas.outcomes.1": "Ausrichtung auf die Bedürfnisse der Nutzer", "resource.api-value-proposition-canvas.outcomes.2": "Verbesserte Zufriedenheit der API-Kunden", "resource.api-value-proposition-canvas.steps.1": "Identifizierung von Merkmalen, die erwartete Gewinne liefern", "resource.api-value-proposition-canvas.steps.2": "Merkmale zur Bewältigung von Herausforderungen definieren", "resource.api-value-proposition-canvas.steps.3": "Zuordnung von Merkmalen zu API-Produkten", "resource.api-value-proposition-canvas.tips.1": "Merkmale hervorheben, die Schmerzen lindern oder Gewinne steigern", "resource.api-value-proposition-canvas.tips.2": "Validierung von Funktionen mit API-Konsumenten zur Gewährleistung der Übereinstimmung", "resource.business-impact-canvas.outcomes.1": "Verbesserte Sicherheit und Konformität", "resource.business-impact-canvas.outcomes.2": "Verbesserte API-Leistung", "resource.business-impact-canvas.steps.1": "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "resource.business-impact-canvas.steps.2": "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "resource.business-impact-canvas.steps.3": "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "resource.business-impact-canvas.steps.4": "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "resource.business-impact-canvas.steps.5": "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken.", "resource.business-impact-canvas.tips.1": "Nutzen Sie vergangene Vorfälle, um potenzielle Risiken zu identifizieren", "resource.business-impact-canvas.tips.2": "Priorisieren Sie kritische APIs mit den größten Auswirkungen auf das Geschäft", "resource.capacity-canvas.outcomes.1": "Vorbereitet auf zukünftige Konsumtrends", "resource.capacity-canvas.outcomes.2": "Definierte Caching- und Ratenbegrenzungsstrategien", "resource.capacity-canvas.steps.1": "Vorhersage künftiger Verbrauchstrends", "resource.capacity-canvas.steps.2": "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "resource.capacity-canvas.steps.3": "Caching und Strategien zur Ratenbegrenzung definieren", "resource.capacity-canvas.steps.4": "Skalierungsstrategien vorschlagen", "resource.capacity-canvas.tips.1": "Szenarien für Nutzungsspitzen definieren", "resource.capacity-canvas.tips.2": "Skalierbarkeitstests in die Planungsphase einbeziehen", "resource.customer-journey-canvas.outcomes.1": "Verbessertes API-Design", "resource.customer-journey-canvas.outcomes.2": "Bessere Nutzererfahrung", "resource.customer-journey-canvas.steps.1": "Identifizieren Sie Auslöser für die Reise", "resource.customer-journey-canvas.steps.2": "Beschreiben Sie das Ende der Reise", "resource.customer-journey-canvas.steps.3": "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "resource.customer-journey-canvas.steps.4": "Kundenbedürfnisse identifizieren", "resource.customer-journey-canvas.steps.5": "Kundengewinne zusammenfassen", "resource.customer-journey-canvas.steps.6": "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "resource.customer-journey-canvas.steps.7": "Definieren Sie API-Interaktionen für jeden Schritt", "resource.customer-journey-canvas.tips.1": "Verwenden Sie die Ergebnisse dieses Canvas als Grundlage für andere Canvas wie den API Value Proposition Canvas", "resource.event-canvas.outcomes.1": "Ereignisauslöser und Verarbeitungslogik löschen", "resource.event-canvas.outcomes.2": "Verbesserte Reaktionsfähigkeit auf Änderungen in Echtzeit", "resource.event-canvas.steps.1": "Definieren Sie Auslöser für jedes Ereignis", "resource.event-canvas.steps.2": "Beschreiben Sie die Backend-Verarbeitungslogik für Ereignisse", "resource.event-canvas.steps.3": "Angabe der resultierenden Ausgaben oder Bestätigungen", "resource.event-canvas.tips.1": "Ereignisabläufe und Abhängigkeiten dokumentieren", "resource.event-canvas.tips.2": "Validierung der Ereignisverarbeitung mit Testfällen", "resource.graphql-canvas.outcomes.1": "Definierte Typen und ihre Beziehungen", "resource.graphql-canvas.outcomes.2": "Abfragen, Mutationen und Abonnements löschen", "resource.graphql-canvas.steps.1": "Definieren Sie GraphQL-Typen und ihre Attribute: Was sind die wichtigsten Typen (z. B. Benutzer, Bestellung, Produkt)?", "resource.graphql-canvas.steps.2": "Beziehungen zwischen Typen abbilden: Wie stehen die Typen in verschachtelten Abfragen zueinander?", "resource.graphql-canvas.steps.3": "Abfragen für den Datenabruf spezifizieren", "resource.graphql-canvas.steps.4": "Definieren Sie Mutationen für Datenänderungen: Durch welche Operationen werden Daten verändert (z. B. Erstellen, Aktualisieren, Löschen)?", "resource.graphql-canvas.steps.5": "Übersichtsabonnements für Echtzeit-Updates", "resource.graphql-canvas.steps.6": "Definieren Sie Authentifizierung und Autorisierung: Wer darf auf welche Felder oder Typen zugreifen?", "resource.graphql-canvas.steps.7": "Überlegen Sie, ob es Einschränkungen in Bezug auf Paginierung, Filterung oder Ratenbegrenzung gibt.", "resource.graphql-canvas.tips.1": "Beispielabfragen und Mutationen dokumentieren", "resource.graphql-canvas.tips.2": "Sicherstellen, dass Typennamen beschreibend und konsistent sind", "resource.interaction-canvas.outcomes.1": "Definierte Inputs und Outputs für jede Interaktion", "resource.interaction-canvas.outcomes.2": "Konsistente Validierungsregeln für alle Interaktionen", "resource.interaction-canvas.steps.1": "Definieren Sie Endpunkte für jede Interaktion", "resource.interaction-canvas.steps.2": "Inputs und Outputs für jede Interaktion zu dokumentieren", "resource.interaction-canvas.steps.3": "Angabe von Validierungsregeln und -beschränkungen", "resource.interaction-canvas.steps.4": "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen", "resource.interaction-canvas.tips.1": "Simulation von Interaktionen mit Scheindaten zur Validierung von Arbeitsabläufen", "resource.interaction-canvas.tips.2": "die erwarteten Reaktionen auf erfolgreiche und erfolglose Interaktionen zu dokumentieren", "resource.location-canvas.outcomes.1": "Optimierte API-Leistung über Regionen hinweg", "resource.location-canvas.outcomes.2": "Verbessertes Verständnis der regionalen Anforderungen", "resource.location-canvas.steps.1": "Dokumentieren Sie, wo sich die Verbraucher befinden.", "resource.location-canvas.steps.2": "Ermitteln Sie die geltenden Vorschriften.", "resource.location-canvas.steps.3": "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "resource.location-canvas.steps.4": "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "resource.location-canvas.steps.5": "Validierung der Netzwerkleistung in verschiedenen Regionen.", "resource.location-canvas.tips.1": "Validierung der Netzleistung in den wichtigsten Regionen", "resource.location-canvas.tips.2": "Proaktive Lösung von standortbedingten Beschränkungen", "resource.rest-canvas.outcomes.1": "Definierte Ressourcen und ihre Interaktionen", "resource.rest-canvas.outcomes.2": "Beispielhafte Anfragen und Antworten zur Verdeutlichung", "resource.rest-canvas.steps.1": "Definieren Sie die Struktur des API-Ressourcenmodells", "resource.rest-canvas.steps.2": "Angabe von HTTP-Verben für die Interaktion mit Ressourcen", "resource.rest-canvas.steps.3": "Geben Sie Beispiele für Anfragen und Antworten für jedes Verb an.", "resource.rest-canvas.tips.1": "Sicherstellen, dass Ressourcen-URIs intuitiv und konsistent sind", "resource.rest-canvas.tips.2": "Fehlerbehandlung und Antwortcodes dokumentieren", "resource.capability-value-proposition-canvas.title": "Capability Value Proposition Canvas", "resource.capability-value-proposition-canvas.description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "resource.capability-value-proposition-canvas.outcomes": "Klare Wertpositionierung der wiederverwendbaren Capability", "resource.capability-value-proposition-canvas.outcomes.1": "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "resource.capability-value-proposition-canvas.outcomes.2": "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert", "resource.capability-value-proposition-canvas.steps": "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "resource.capability-value-proposition-canvas.steps.1": "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "resource.capability-value-proposition-canvas.steps.2": "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "resource.capability-value-proposition-canvas.steps.3": "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities.", "resource.capability-value-proposition-canvas.tips": "Bleiben Sie technologieunabhängig, bis die Anforderungen auf einen Stil hinweisen.", "resource.capability-value-proposition-canvas.tips.1": "Verwenden Sie dies anstelle des API Value Proposition Canvas, wenn API noch nicht der gewählte Implementierungsstil ist.", "resource.capability-business-model-canvas.title": "Capability Business Model Canvas", "resource.capability-business-model-canvas.description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "resource.capability-business-model-canvas.outcomes": "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "resource.capability-business-model-canvas.outcomes.1": "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "resource.capability-business-model-canvas.outcomes.2": "Kosten und Nutzen vor der Architekturfestlegung sichtbar", "resource.capability-business-model-canvas.steps": "Fassen Sie die Wertpositionierung der Capability zusammen.", "resource.capability-business-model-canvas.steps.1": "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "resource.capability-business-model-canvas.steps.2": "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "resource.capability-business-model-canvas.steps.3": "Erfassen Sie Kosten und Nutzen.", "resource.capability-business-model-canvas.steps.4": "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "resource.capability-business-model-canvas.steps.5": "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern.", "resource.capability-business-model-canvas.tips": "Verwenden Sie dies anstelle des API Business Model Canvas, wenn der Implementierungsstil noch offen ist.", "resource.capability-business-model-canvas.tips.1": "Fokussieren Sie auf die Tragfähigkeit der wiederverwendbaren Capability, nicht auf eine einmalige Verbindung.", "resource.consumer-experience-requirements-canvas.title": "Consumer Experience Requirements Canvas", "resource.consumer-experience-requirements-canvas.description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "resource.consumer-experience-requirements-canvas.outcomes": "Technologieunabhängige Nutzeranforderungen", "resource.consumer-experience-requirements-canvas.outcomes.1": "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "resource.consumer-experience-requirements-canvas.outcomes.2": "Architekturauswirkungen für die Stilauswahl dokumentiert", "resource.consumer-experience-requirements-canvas.steps": "Erfassen Sie Nutzerziele und Nutzungskontext.", "resource.consumer-experience-requirements-canvas.steps.1": "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "resource.consumer-experience-requirements-canvas.steps.2": "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "resource.consumer-experience-requirements-canvas.steps.3": "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten.", "resource.consumer-experience-requirements-canvas.tips": "Verwenden Sie dies als Brücke zwischen Capability-Wert und Architekturentscheidung.", "resource.consumer-experience-requirements-canvas.tips.1": "Wählen Sie API, Event, Datei, Stream oder Datenprodukt erst aus, wenn die Anforderungen die Passung erkennen lassen.", "resource.integration-style-selection-guide.title": "Leitfaden zur Auswahl des Implementierungsstils", "resource.integration-style-selection-guide.description": "Orientierung zur Auswahl zwischen API, Event, Datei, Stream, Datenprodukt, direkter Integration oder hybriden Implementierungsstilen auf Grundlage von Anforderungen und Rahmenbedingungen.", "resource.integration-style-selection-guide.outcomes": "Begründeter Implementierungsstil für die Integration", "resource.integration-style-selection-guide.outcomes.1": "Abwägungen zwischen den Optionen für den Implementierungsstil dokumentiert", "resource.integration-style-selection-guide.outcomes.2": "Ausgewählter Stil auf Anforderungen von Nutzern, Plattform, Daten und Betrieb zurückführbar", "resource.integration-style-selection-guide.steps": "Vergleichen Sie tragfähige Implementierungsstile anhand von Latenz, Volumen, Kopplung, Datenverantwortung, Aktualität, Governance und Betriebsfähigkeit.", "resource.integration-style-selection-guide.steps.1": "Identifizieren Sie, wann API, Event, Datei, Stream, Datenprodukt, direkte Integration oder hybride Ansätze zum Anwendungsfall passen.", "resource.integration-style-selection-guide.steps.2": "Dokumentieren Sie Einschränkungen, Risiken und Plattformabhängigkeiten für den ausgewählten Implementierungsstil.", "resource.integration-style-selection-guide.steps.3": "Halten Sie fest, warum verworfene Alternativen nicht ausgewählt wurden.", "resource.integration-style-selection-guide.tips": "Verwenden Sie diese Ressource, nachdem die Anforderungen explizit sind und bevor das detaillierte Vertragsdesign beginnt.", "resource.integration-style-selection-guide.tips.1": "Behalten Sie REST-, Event-, GraphQL-, Datei-, Stream- und Datenprodukt-Ressourcen als optionale nachgelagerte Designressourcen bei.", "resource.process-workflow-design-guide.title": "Leitfaden für Prozess- und Workflow-Design", "resource.process-workflow-design-guide.description": "Orientierung zur Modellierung von Prozessschritten, Rollen, Übergaben, Entscheidungspunkten, Zuständen, Eingaben, Ausgaben und Ausnahmen, die einen Automatisierungs-Workflow prägen.", "resource.process-workflow-design-guide.outcomes": "Klares Design des Automatisierungs-Workflows", "resource.process-workflow-design-guide.outcomes.1": "Prozessschritte und Übergaben vor der Implementierung dokumentiert", "resource.process-workflow-design-guide.outcomes.2": "Workflow-Zustände, Eingaben, Ausgaben und Ausnahmewege verstanden", "resource.process-workflow-design-guide.steps": "Modellieren Sie den aktuellen und den Ziel-Prozessfluss einschließlich menschlicher und systemseitiger Verantwortlichkeiten.", "resource.process-workflow-design-guide.steps.1": "Identifizieren Sie Workflow-Auslöser, Zustände, Entscheidungen, Dateneingaben, Ausgaben und Abschlusskriterien.", "resource.process-workflow-design-guide.steps.2": "Dokumentieren Sie Übergaben zwischen Nutzern, Systemen, Betrieb und Supportrollen.", "resource.process-workflow-design-guide.steps.3": "Bestätigen Sie, welche Schritte automatisiert werden sollen und welche menschliches Urteilsvermögen erfordern.", "resource.process-workflow-design-guide.tips": "Halten Sie Prozessdesign vom API- oder Integrationsvertragsdesign getrennt, bis der Workflow klar ist.", "resource.process-workflow-design-guide.tips.1": "Verwenden Sie diese Ressource als primäre Designressource für Automatisierungs-Workflows.", "resource.decision-business-rules-guide.title": "Leitfaden für Entscheidungen und Geschäftsregeln", "resource.decision-business-rules-guide.description": "Orientierung zur Erfassung von Regeln, Schwellenwerten, Entscheidungen, Genehmigungen, Eignungsprüfungen und Regelverantwortung für das Automatisierungsdesign.", "resource.decision-business-rules-guide.outcomes": "Explizite Entscheidungen und Geschäftsregeln", "resource.decision-business-rules-guide.outcomes.1": "Regeln und Schwellenwerte mit Verantwortlichen dokumentiert", "resource.decision-business-rules-guide.outcomes.2": "Automatisierungsentscheidungen auf Richtlinien, Prozesse oder Geschäftsabsicht zurückführbar", "resource.decision-business-rules-guide.steps": "Listen Sie Entscheidungen auf, die die Automatisierung treffen oder unterstützen muss.", "resource.decision-business-rules-guide.steps.1": "Dokumentieren Sie Regelbedingungen, Schwellenwerte, Ausnahmen, Genehmigungen und Eskalationspunkte.", "resource.decision-business-rules-guide.steps.2": "Identifizieren Sie Regelverantwortliche und Änderungsgovernance für jeden Entscheidungsbereich.", "resource.decision-business-rules-guide.tips": "Trennen Sie stabile Geschäftsregeln von konfigurierbaren betrieblichen Parametern.", "resource.decision-business-rules-guide.tips.1": "Nutzen Sie Beispiele und Grenzfälle, um die Regelauslegung zu validieren.", "resource.automation-trigger-handoff-exception-guide.title": "Leitfaden für Automatisierungsauslöser, Übergaben und Ausnahmen", "resource.automation-trigger-handoff-exception-guide.description": "Orientierung zur Definition von Automatisierungsauslösern, menschlichen Übergaben, Ausnahmebehandlung, Wiederholungen, Ausgleichsmaßnahmen und Support-Eskalationswegen.", "resource.automation-trigger-handoff-exception-guide.outcomes": "Definierte Automatisierungsauslöser und Ausnahmewege", "resource.automation-trigger-handoff-exception-guide.outcomes.1": "Menschliche Übergaben und Support-Eskalationen sind explizit", "resource.automation-trigger-handoff-exception-guide.outcomes.2": "Ausnahmen, Wiederholungen und Ausgleichsmaßnahmen sind vor der Bereitstellung entworfen", "resource.automation-trigger-handoff-exception-guide.steps": "Definieren Sie Ereignisse, Zeitpläne, Nutzeraktionen oder Systemzustände, die die Automatisierung auslösen.", "resource.automation-trigger-handoff-exception-guide.steps.1": "Modellieren Sie Übergaben von der Automatisierung an Nutzer, Betreiber oder Supportteams.", "resource.automation-trigger-handoff-exception-guide.steps.2": "Dokumentieren Sie Ausnahmen, Wiederholungsregeln, Timeout-Verhalten und Rückfallwege.", "resource.automation-trigger-handoff-exception-guide.steps.3": "Definieren Sie Warnungen und Eskalationsschwellen für fehlgeschlagene oder uneindeutige Automatisierungsergebnisse.", "resource.automation-trigger-handoff-exception-guide.tips": "Gestalten Sie Ausnahmewege als vollwertiges Workflow-Verhalten, nicht als nachträgliche Ergänzung.", "resource.automation-trigger-handoff-exception-guide.tips.1": "Beziehen Sie Geschäfts- und Betriebsrollen ein, wenn Übergaben validiert werden.", "resource.automation-testing-guide.title": "Leitfaden für Automatisierungstests", "resource.automation-testing-guide.description": "Orientierung zum Testen automatisierter Workflows, Entscheidungen, Integrationen, Ausnahmen, Rollback-Verhalten, Überwachung und Nutzerauswirkungen vor der Veröffentlichung.", "resource.automation-testing-guide.outcomes": "Validiertes Automatisierungsverhalten", "resource.automation-testing-guide.outcomes.1": "Workflow-, Regel-, Ausnahme- und Integrationstests definiert", "resource.automation-testing-guide.outcomes.2": "Veröffentlichungssicherheit für automatisierte und menschlich unterstützte Pfade", "resource.automation-testing-guide.steps": "Erstellen Sie Tests für Standardabläufe, Grenzfälle, Ausnahmen, Wiederholungen und Übergaben.", "resource.automation-testing-guide.steps.1": "Validieren Sie Geschäftsregeln und Entscheidungsergebnisse mit repräsentativen Daten.", "resource.automation-testing-guide.steps.2": "Testen Sie Rollback, Wiederherstellung, Beobachtbarkeit und manuelle Eingriffspfade.", "resource.automation-testing-guide.steps.3": "Beziehen Sie Nutzer und Betreiber in Abnahmetests ein, wenn die Automatisierung Arbeitsweisen verändert.", "resource.automation-testing-guide.tips": "Verwenden Sie produktionsnahe Szenarien und Datenstrukturen, ohne sensible Daten offenzulegen.", "resource.automation-testing-guide.tips.1": "Halten Sie Testnachweise für die Bereitschaftsprüfung verfügbar.", "resource.automation-operational-ownership-guide.title": "Leitfaden für die betriebliche Verantwortung von Automatisierungen", "resource.automation-operational-ownership-guide.description": "Orientierung zur Definition von Verantwortung, Runbooks, Überwachung, Support, Monitoring, Änderungskontrolle und kontinuierlicher Verbesserung für Automatisierungen.", "resource.automation-operational-ownership-guide.outcomes": "Klares Betriebsmodell für die Automatisierung", "resource.automation-operational-ownership-guide.outcomes.1": "Verantwortlichkeiten für Eigentum, Support und Eskalation zugewiesen", "resource.automation-operational-ownership-guide.outcomes.2": "Monitoring- und Änderungspraktiken für den Live-Betrieb bereit", "resource.automation-operational-ownership-guide.steps": "Definieren Sie fachliche, technische und betriebliche Verantwortliche für die Automatisierung.", "resource.automation-operational-ownership-guide.steps.1": "Dokumentieren Sie Runbooks, Supportwege, Monitoring-Signale, Serviceerwartungen und Eskalationsregeln.", "resource.automation-operational-ownership-guide.steps.2": "Legen Sie Änderungskontrolle und Review-Praktiken für Workflow-, Plattform- und Regeländerungen fest.", "resource.automation-operational-ownership-guide.tips": "Veröffentlichen Sie keine Automatisierung ohne benannte verantwortliche Person für Ausnahmen und laufende Verbesserung.", "resource.automation-operational-ownership-guide.tips.1": "Machen Sie Überwachungsbedarf sichtbar, bevor die Bereitstellungsplanung abgeschlossen ist.", "resource.automation-rollback-supervision-guide.title": "Leitfaden für Rollback und Überwachung von Automatisierungen", "resource.automation-rollback-supervision-guide.description": "Orientierung zur Gestaltung von Rollback-, Pausen-, manuellen Übersteuerungs-, Monitoring-, Überwachungs- und Wiederherstellungspfaden für Automatisierungen.", "resource.automation-rollback-supervision-guide.outcomes": "Kontrollierte Wiederherstellungspfade für Automatisierungen", "resource.automation-rollback-supervision-guide.outcomes.1": "Rollback-, Pausen- und Übersteuerungsverhalten dokumentiert", "resource.automation-rollback-supervision-guide.outcomes.2": "Überwachungsbedarf und Wiederherstellungsverantwortlichkeiten definiert", "resource.automation-rollback-supervision-guide.steps": "Identifizieren Sie Aktionen, die rückgängig gemacht, pausiert oder manuell übersteuert werden können müssen.", "resource.automation-rollback-supervision-guide.steps.1": "Definieren Sie Rollback-, Kompensations- und Wiederherstellungsverfahren für fehlgeschlagene oder falsche Automatisierungsergebnisse.", "resource.automation-rollback-supervision-guide.steps.2": "Dokumentieren Sie Überwachungsschwellen, Warnungen und manuelle Entscheidungspunkte.", "resource.automation-rollback-supervision-guide.steps.3": "Validieren Sie Wiederherstellungsverfahren vor der Veröffentlichung.", "resource.automation-rollback-supervision-guide.tips": "Behandeln Sie Rollback und Überwachung als Teil des Workflow-Designs und des Bereitstellungsplans.", "resource.automation-rollback-supervision-guide.tips.1": "Nutzen Sie betriebliche Vorfälle und Beinahe-Vorfälle, um Überwachungskriterien zu verfeinern.", "resource.automation-readiness-checklist.title": "Checkliste zur Automatisierungsbereitschaft", "resource.automation-readiness-checklist.description": "Eine Checkliste zur Validierung von Automatisierungs-Workflow, Kontrollen, Risiko, Compliance, menschlicher Aufsicht, Testnachweisen, Rollback, Betrieb und Veröffentlichungsbereitschaft.", "resource.automation-readiness-checklist.outcomes": "Dokumentierte Automatisierungsbereitschaft", "resource.automation-readiness-checklist.outcomes.1": "Bekannte Bereitschaftslücken und Gegenmaßnahmen vor der Veröffentlichung", "resource.automation-readiness-checklist.outcomes.2": "Nachweise für Qualität, Risiko, Compliance, Aufsicht und betriebliche Freigabe", "resource.automation-readiness-checklist.steps": "Prüfen Sie Workflow-Design, Geschäftsregeln, Kontrollen, Zugriff, Datenverarbeitung und Ausnahmewege.", "resource.automation-readiness-checklist.steps.1": "Überprüfen Sie Testnachweise, Rollback-Verfahren, Überwachungsmodell und Supportbereitschaft.", "resource.automation-readiness-checklist.steps.2": "Bestätigen Sie Verantwortung, Runbooks, Monitoring, Änderungskontrollen und Veröffentlichungsfreigabe.", "resource.automation-readiness-checklist.steps.3": "Dokumentieren Sie ungelöste Lücken, Entscheidungen und akzeptierte Risiken vor der Veröffentlichung.", "resource.automation-readiness-checklist.tips": "Verwenden Sie die Checkliste vor der Veröffentlichung und erneut nach wesentlichen Workflow- oder Regeländerungen.", "resource.automation-readiness-checklist.tips.1": "Machen Sie menschliche Aufsicht und Ausnahmebehandlung in den Nachweisen explizit.", "resource.automation-rollout-enablement-guide.title": "Leitfaden für Rollout und Enablement von Automatisierungen", "resource.automation-rollout-enablement-guide.description": "Orientierung für die Einführung von Automatisierungen mit Nutzerkommunikation, Onboarding, Betriebsanweisungen, Supportwegen, Change Management und Feedback-Schleifen.", "resource.automation-rollout-enablement-guide.outcomes": "Befähigte Automatisierungsnutzer und Betreiber", "resource.automation-rollout-enablement-guide.outcomes.1": "Rollout-Kommunikation, Onboarding und Supportwege vorbereitet", "resource.automation-rollout-enablement-guide.outcomes.2": "Nutzer und Betreiber verstehen, wie sich die Arbeit nach der Veröffentlichung der Automatisierung verändert", "resource.automation-rollout-enablement-guide.steps": "Definieren Sie Rollout-Zielgruppen, Zeitplan, Kommunikationskanäle und Schulungsbedarf.", "resource.automation-rollout-enablement-guide.steps.1": "Veröffentlichen Sie Betriebsanweisungen, Supportwege, Hinweise zur Ausnahmebehandlung und Eskalationskontakte.", "resource.automation-rollout-enablement-guide.steps.2": "Planen Sie Übergangsunterstützung für Nutzer, Betreiber und Prozessverantwortliche.", "resource.automation-rollout-enablement-guide.steps.3": "Sammeln Sie Feedback nach dem Rollout und überführen Sie Verbesserungen in den Backlog.", "resource.automation-rollout-enablement-guide.tips": "Verwenden Sie für Automatisierungen Rollout-Sprache, statt Enablement wie API-Veröffentlichung zu behandeln.", "resource.automation-rollout-enablement-guide.tips.1": "Beziehen Sie sowohl die vom Prozess betroffenen Nutzer als auch die für die Automatisierung verantwortlichen Betreiber ein.", "resource.api-community-engagement-strategies.tips.2": "Verwenden Sie diese Ressource, wenn eine API der ausgewählte Implementierungsstil ist.", "resource.api-development-best-practices.tips.2": "Verwenden Sie diese Ressource, wenn eine API der ausgewählte Implementierungsstil ist.", "resource.api-metrics-and-analytics.tips.2": "Verwenden Sie diese Ressource, wenn eine API der ausgewählte Implementierungsstil ist.", "resource.api-testing-best-practices.tips.2": "Verwenden Sie diese Ressource, wenn eine API der ausgewählte Implementierungsstil ist.", "resource.apiops-CI-CD-for-apis.tips.2": "Verwenden Sie diese Ressource, wenn eine API der ausgewählte Implementierungsstil ist.", "resource.api-audit-checklist.tips.2": "Verwenden Sie diese Ressource, wenn eine API der ausgewählte Implementierungsstil ist.", "exit_criteria": "Austrittskriterien", "entry_criteria": "Einstiegskriterien", "criterion.metrics-feedback-available": "Relevante Marktsignale, Feedback oder operative Erkenntnisse liegen vor, um diese Capability-Möglichkeit zu bewerten.", "criterion.business-goals-defined": "Die Geschäftsziele sind definiert.", "criterion.market-research-done": "Die Marktrecherche identifiziert relevante Capability-Möglichkeiten.", "criterion.stakeholder-approval": "Die relevanten Stakeholder stimmen zu, dass diese Capability-Möglichkeit weiter untersucht und priorisiert werden sollte.", "criterion.api-opportunity-documented": "Die Capability-Möglichkeit wurde identifiziert und dokumentiert.", "criterion.api-reusability": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "criterion.hide-backend-discrepancies": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "criterion.value-prop-validated": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "criterion.consumer-segments-identified": "Die Nutzersegmente sind identifiziert.", "criterion.api-roadmap-defined": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "criterion.architecture-patterns-validated": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "criterion.design-reflects-business-value": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "criterion.api-consistency": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "criterion.api-contract-tested": "Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.", "criterion.automation-workflow-validated": "Workflow, Regeln, Integrationen und relevante Schnittstellenverträge wurden validiert und getestet.", "criterion.api-description-available": "Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.", "criterion.audit-passed": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "criterion.audit-reports-shared": "Audit-Ergebnisse und Maßnahmenentscheidungen wurden mit den relevanten Stakeholdern geteilt.", "criterion.api-ready-for-publishing": "Die Capability ist bereit, über den gewählten Bereitstellungsmechanismus veröffentlicht oder ausgeliefert zu werden.", "criterion.api-documentation-ready": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "criterion.consumer-support-ready": "Onboarding-, Support- und Kommunikationsprozesse für Nutzer sind bereit.", "criterion.legal-compliance-clear": "Rechtliche, Datenschutz- und Compliance-Anforderungen für Veröffentlichung oder Release sind definiert und verstanden.", "stakeholder.involvement.lead": "Federführend", "stakeholder.involvement.core": "Kern", "stakeholder.involvement.consulted": "Konsultiert", "stakeholder.business-owner.title": "Business Owner", "stakeholder.business-owner.description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "stakeholder.api-program-owner.title": "API-Programmverantwortlicher", "stakeholder.api-program-owner.description": "Koordiniert API-Portfolio-Praktiken, organisatorische Ausrichtung und langfristige Entwicklung von API-Capabilities.", "stakeholder.api-product-owner.title": "API Product Owner", "stakeholder.api-product-owner.description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "stakeholder.capability-owner.title": "Capability Owner", "stakeholder.capability-owner.description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "stakeholder.domain-specialist.title": "Domain-Experte", "stakeholder.domain-specialist.description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "stakeholder.customer-specialist.title": "Kunden- oder Partnervertreter", "stakeholder.customer-specialist.description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "stakeholder.api-consumer-specialist.title": "Vertreter der API-Nutzer", "stakeholder.api-consumer-specialist.description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "stakeholder.platform-architect.title": "Plattform-Architekt", "stakeholder.platform-architect.description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "stakeholder.api-architect.title": "API-Architekt", "stakeholder.api-architect.description": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "stakeholder.integration-architect.title": "Integrationsarchitekt", "stakeholder.integration-architect.description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "stakeholder.platform-owner.title": "Plattformverantwortlicher", "stakeholder.platform-owner.description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "stakeholder.api-designer.title": "API-Designer", "stakeholder.api-designer.description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "stakeholder.api-engineer.title": "API-Entwickler", "stakeholder.api-engineer.description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "stakeholder.automation-owner.title": "Automatisierungsverantwortlicher", "stakeholder.automation-owner.description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "stakeholder.process-owner.title": "Prozessverantwortlicher", "stakeholder.process-owner.description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "stakeholder.automation-engineer.title": "Automatisierungsingenieur", "stakeholder.automation-engineer.description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "stakeholder.security-specialist.title": "Sicherheitsspezialist", "stakeholder.security-specialist.description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "stakeholder.compliance-specialist.title": "Compliance- und Rechtsexperte", "stakeholder.compliance-specialist.description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "stakeholder.governance-specialist.title": "Governance-Verantwortlicher", "stakeholder.governance-specialist.description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "stakeholder.api-devrel-specialist.title": "Verantwortlicher für Dokumentation und DevRel", "stakeholder.api-devrel-specialist.description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "stakeholder.operations-specialist.title": "Verantwortlicher für Support und Betrieb", "stakeholder.operations-specialist.description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "stakeholder.partner-specialist.title": "Partner- und Lieferantenmanager", "stakeholder.partner-specialist.description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "lines.title": "Metro-Linien", "lines.description": "APIOps Cycles-Metrolinien zur Unterstützung der Planung, Umsetzung und Weiterentwicklung von Capabilities, APIs und Integrationen.", "line.business-opportunities-line.title": "Linie Geschäftsmöglichkeiten", "line.business-opportunities-line.description": "Konzentriert sich auf die Identifizierung, Bewertung und Produktisierung von Geschäftsmöglichkeiten als wiederverwendbare Capabilities.", "line.platform-architecture-line.title": "Linie Plattformarchitektur", "line.platform-architecture-line.description": "Behandelt Architekturentscheidungen für Plattformen, Integrationen und Schnittstellen.", "line.api-design-line.title": "API-Entwurfslinie", "line.api-design-line.description": "Konzentriert sich auf Entwurfsprinzipien und Best Practices für Schnittstellen und Integrationslösungen.", "line.delivery-line.title": "Bereitstellungslinie", "line.delivery-line.description": "Behandelt Implementierung, Tests, Automatisierung und Bereitstellungspraktiken.", "line.publishing-and-adoption-line.title": "Linie Veröffentlichung & Enablement", "line.publishing-and-adoption-line.description": "Konzentriert sich auf die Veröffentlichung von Capabilities sowie deren Auffindbarkeit, Onboarding und Nutzung.", "line.operating-model-line.title": "Linie Betriebsmodell", "line.operating-model-line.description": "Behandelt Governance, Verantwortlichkeiten und das Betriebsmodell für Capabilities." }, "cycles": [ { "id": "capability-productization-cycle", "slug": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird.", "purpose": "Identifizieren und produktisieren Sie wiederverwendbare digitale Capabilities, bevor Sie einen API-, Event-, Datei-, Stream-, Datenprodukt-, KI-Service-, direkte Integrations- oder hybriden Implementierungsstil waehlen.", "audiences": [], "audienceStakeholders": [ { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "role": "suggested-answer-owner" } ] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [ { "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "lead", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [ { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "lead", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "lead", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "lead", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] } ], "entryCriteria": [ "business-goals-defined", "stakeholder-approval" ], "exitCriteria": [ "value-prop-validated", "architecture-patterns-validated", "audit-passed" ], "entryCriteriaDetails": [ { "id": "business-goals-defined", "title": "Die Geschäftsziele sind definiert.", "description": "Business goals are defined." }, { "id": "stakeholder-approval", "title": "Die relevanten Stakeholder stimmen zu, dass diese Capability-Möglichkeit weiter untersucht und priorisiert werden sollte.", "description": "Relevant stakeholders agree this API opportunity is worth exploring and prioritizing." } ], "exitCriteriaDetails": [ { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "audit-passed", "title": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "description": "The API passes compliance, security, and audit checks." } ], "questionnaireResources": [ { "stationId": "api-product-strategy", "stationTitle": "Capability-Strategie", "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "suggestedAnswerOwner": { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "Capability-Strategie", "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "suggestedAnswerOwner": { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "Capability-Strategie", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "suggestedAnswerOwner": { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "Capability-Strategie", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "suggestedAnswerOwner": { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-consumer-experience", "stationTitle": "Nutzeranforderungen & Onboarding", "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "suggestedAnswerOwner": { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [ { "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-platform-architecture", "stationTitle": "Architektur & Plattformentscheidungen", "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "suggestedAnswerOwner": { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "lead", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-platform-architecture", "stationTitle": "Architektur & Plattformentscheidungen", "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "suggestedAnswerOwner": { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-platform-architecture", "stationTitle": "Architektur & Plattformentscheidungen", "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "suggestedAnswerOwner": { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [ { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] } } ], "stations": [ { "index": 1, "id": "api-product-strategy", "slug": "method/api-product-strategy", "icon": "strategy-outline", "title": "Capability-Strategie", "description": "Rahmen Sie den Geschaeftsbedarf als wiederverwendbare Capability mit klarem Wert, Nutzern, Ownership und Geschaeftszielen, bevor der Implementierungsstil gewaehlt wird.", "whyItMatters": "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden.", "applyInWork": "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "outcomes": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung" ], "steps": [ { "text": "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas" } ], "questions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "criteria": [ "metrics-feedback-available", "business-goals-defined", "market-research-done", "stakeholder-approval" ], "criteriaDetails": [ { "id": "metrics-feedback-available", "title": "Relevante Marktsignale, Feedback oder operative Erkenntnisse liegen vor, um diese Capability-Möglichkeit zu bewerten.", "description": "Relevant market signals, feedback, or operational insights are available to guide this API opportunity." }, { "id": "business-goals-defined", "title": "Die Geschäftsziele sind definiert.", "description": "Business goals are defined." }, { "id": "market-research-done", "title": "Die Marktrecherche identifiziert relevante Capability-Möglichkeiten.", "description": "Market research identifies API opportunities." }, { "id": "stakeholder-approval", "title": "Die relevanten Stakeholder stimmen zu, dass diese Capability-Möglichkeit weiter untersucht und priorisiert werden sollte.", "description": "Relevant stakeholders agree this API opportunity is worth exploring and prioritizing." } ], "baseTitle": "Strategie", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "stakeholders": [ { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "role": "suggested-answer-owner" } ] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "core", "responsibilities": [] }, { "id": "api-program-owner", "sourceKey": "api-program-owner", "sourceStakeholderId": "api-program-owner", "title": "API-Programmverantwortlicher", "description": "Koordiniert API-Portfolio-Praktiken, organisatorische Ausrichtung und langfristige Entwicklung von API-Capabilities.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "evidence": [ "design-artifact", "documentation", "research", "roadmap" ] }, { "index": 2, "id": "api-consumer-experience", "slug": "method/api-consumer-experience", "icon": "deployed-code-account-outline", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding-Bedarf, Einschränkungen, Serviceerwartungen und Verantwortlichkeiten der Anbieter.", "whyItMatters": "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab.", "applyInWork": "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "outcomes": [ "Explizite Nutzeranforderungen und Onboarding-Erwartungen", "Definieren Sie die API-Erlebnisreise", "Onboarding, Dokumentation und Feedback planen", "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)" ], "steps": [ { "text": "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null } ], "questions": [ "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab." ], "criteria": [ "api-opportunity-documented", "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-opportunity-documented", "title": "Die Capability-Möglichkeit wurde identifiziert und dokumentiert.", "description": "Individual API opportunities are identified and documented." }, { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "baseTitle": "Nutzeranforderungen & Onboarding", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "stakeholders": [ { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "lead", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [ { "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "consulted", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "design-artifact", "documentation", "consumer-feedback" ] }, { "index": 3, "id": "api-platform-architecture", "slug": "method/api-platform-architecture", "icon": "code-blocks-outline", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschraenkungen, um Implementierungsstil, Architekturpattern und ermoeglichende Plattformfaehigkeiten auszuwaehlen.", "whyItMatters": "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen.", "applyInWork": "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "outcomes": [ "Validierte Architektur- und Plattformentscheidung", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit" ], "steps": [ { "text": "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas" }, { "text": "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas" }, { "text": "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas" }, { "text": "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null } ], "questions": [ "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen." ], "criteria": [ "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "baseTitle": "Architektur & Plattformentscheidungen", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "architecture", "stakeholders": [ { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "lead", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "role": "suggested-answer-owner" } ] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [ { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "evidence": [ "architecture-decision", "documentation", "platform-config", "metrics" ] }, { "index": 4, "id": "api-design", "slug": "method/api-design", "icon": "api", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie den Schnittstellenvertrag und das Interaktionsmodell für die gewählte Umsetzungsweise.", "whyItMatters": "Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist.", "applyInWork": "Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.", "outcomes": [ "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise", "Wiederverwendbare und validierte Schnittstellenverträge", "Entwürfe, die auf Domänenmodelle und Interaktionsmuster abgestimmt sind", "Rückverfolgbarkeit des Designs zum Geschäftswert" ], "steps": [ { "text": "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "resourceId": "interactionCanvas", "resourceTitle": "Interaction Canvas", "canvasId": "interactionCanvas" }, { "text": "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "restCanvas", "resourceTitle": "REST Canvas", "canvasId": "restCanvas" }, { "text": "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "eventCanvas", "resourceTitle": "Event Canvas", "canvasId": "eventCanvas" }, { "text": "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "graphqlCanvas", "resourceTitle": "GraphQL Canvas", "canvasId": "graphqlCanvas" }, { "text": "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "resourceId": "api-design-principles", "resourceTitle": "API Design Prinzipien", "canvasId": null }, { "text": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "resourceId": "contract-first-design", "resourceTitle": "Vertrag Erstes Design", "canvasId": null }, { "text": "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.", "Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "baseTitle": "Lösungs- & Schnittstellendesign", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "design", "stakeholders": [ { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "lead", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "consulted", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true } ], "evidence": [ "spec", "contract", "design-artifact", "documentation" ] }, { "index": 5, "id": "api-delivery", "slug": "method/api-delivery", "icon": "code", "title": "Bereitstellung & Betrieb", "description": "Bauen, testen, veröffentlichen und betreiben Sie die Capability mit der gewählten Umsetzungsweise und dem validierten Schnittstellenvertrag.", "whyItMatters": "Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird.", "applyInWork": "Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.", "outcomes": [ "Eine bereitgestellte Capability, die mit dem validierten Schnittstellenvertrag übereinstimmt", "Zuverlässige und automatisierte CI/CD-Pipelines", "Funktionale und nicht-funktionale Tests integriert", "Sichere und gesetzeskonforme Bereitstellungspipelines" ], "steps": [ { "text": "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "resourceId": "api-testing-best-practices", "resourceTitle": "Bewährte Praktiken für API-Tests", "canvasId": null }, { "text": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "resourceId": "api-security-best-practices", "resourceTitle": "Bewährte Praktiken für die API-Sicherheit", "canvasId": null }, { "text": "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.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags 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.", "Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.", "Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "baseTitle": "Bereitstellung & Betrieb", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "delivery", "stakeholders": [ { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "lead", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "consulted", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "implementation", "pipeline-config", "test-report", "security-report" ] }, { "index": 6, "id": "api-audit", "slug": "method/api-audit", "icon": "check-box-outline", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Validieren Sie Schnittstellenvertrag, Kontrollen, Dokumentation, Supportmodell und operative Bereitschaft vor der Veroeffentlichung.", "whyItMatters": "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung.", "applyInWork": "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "outcomes": [ "Dokumentierte Bereitschaft für Veröffentlichung und Wiederverwendung", "Klare Dokumentation des API-Designs und der Implementierungsentscheidungen", "Sicherheit, Leistung und Compliance validiert", "Geringeres Risiko von Problemen in der Produktion" ], "steps": [ { "text": "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null }, { "text": "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.", "resourceId": "api-compliance-best-practices", "resourceTitle": "Bewährte Praktiken zur API-Einhaltung", "canvasId": null }, { "text": "Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.", "resourceTitle": "", "canvasId": null } ], "questions": [ "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "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.", "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung." ], "criteria": [ "architecture-patterns-validated", "design-reflects-business-value", "api-description-available", "api-consistency", "api-contract-tested" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-description-available", "title": "Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.", "description": "The API and its exposed capabilities are described clearly enough for review, audit, and onboarding." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." }, { "id": "api-contract-tested", "title": "Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.", "description": "The API contract is tested and meets functional and non-functional requirements." } ], "baseTitle": "Qualitäts- & Bereitschaftssicherung", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "stakeholders": [ { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "lead", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false }, { "id": "api-compliance-best-practices", "slug": "resources/api-compliance-best-practices", "title": "Bewährte Praktiken zur API-Einhaltung", "description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 104, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "audit-report", "compliance-report", "security-report", "test-report" ] }, { "index": 7, "id": "api-publishing", "slug": "method/api-publishing", "icon": "deployed-code-outline", "title": "Veroeffentlichung & Enablement", "description": "Veroeffentlichen Sie die Capability, damit Nutzer sie finden, bewerten, Zugriff beantragen, das Onboarding abschliessen, sie nutzen und Support erhalten koennen.", "whyItMatters": "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen.", "applyInWork": "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "outcomes": [ "Eine auffindbare und nutzbare Capability", "Klare API-Einführungs- und Registrierungsprozesse", "Dokumentation, Sicherheitsmodelle und Richtlinien verfügbar", "APIs bereit für Skalierung und Governance" ], "steps": [ { "text": "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null }, { "text": "Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "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.", "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen." ], "criteria": [ "audit-passed", "audit-reports-shared", "api-ready-for-publishing", "api-documentation-ready" ], "criteriaDetails": [ { "id": "audit-passed", "title": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "description": "The API passes compliance, security, and audit checks." }, { "id": "audit-reports-shared", "title": "Audit-Ergebnisse und Maßnahmenentscheidungen wurden mit den relevanten Stakeholdern geteilt.", "description": "Audit findings and remediation decisions are shared with the relevant stakeholders." }, { "id": "api-ready-for-publishing", "title": "Die Capability ist bereit, über den gewählten Bereitstellungsmechanismus veröffentlicht oder ausgeliefert zu werden.", "description": "The API is ready to be deployed and exposed through the intended gateways and environments." }, { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." } ], "baseTitle": "Veröffentlichung & Enablement", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "stakeholders": [ { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "service-agreement-template", "slug": "resources/service-agreement-template", "title": "Vorlage für eine Dienstleistungsvereinbarung", "description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "category": "guideline", "icon": "edit-document-outline", "order": 172, "outcomes": [ "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "gateway-config", "developer-portal", "documentation", "release-record" ] }, { "index": 8, "id": "monitoring-and-improving", "slug": "method/monitoring-and-improving", "icon": "analytics-outline", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Capability-Gesundheit, Nutzerergebnisse, Zuverlässigkeit, Wiederverwendung und Verbesserungsmöglichkeiten.", "whyItMatters": "Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern.", "applyInWork": "Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.", "outcomes": [ "Gemessene Capability-Gesundheit und Wertbeitrag", "Feedback-Schleifen für Entwickler sind vorhanden", "Kontinuierlich ermittelte und behandelte Probleme", "Iteration der API, abgestimmt auf die Bedürfnisse der Nutzer" ], "steps": [ { "text": "Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null }, { "text": "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null }, { "text": "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null } ], "questions": [ "Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.", "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.", "Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.", "Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern." ], "criteria": [ "api-documentation-ready", "consumer-support-ready", "legal-compliance-clear" ], "criteriaDetails": [ { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." }, { "id": "consumer-support-ready", "title": "Onboarding-, Support- und Kommunikationsprozesse für Nutzer sind bereit.", "description": "Registration, support, and communication processes are ready for API consumers." }, { "id": "legal-compliance-clear", "title": "Rechtliche, Datenschutz- und Compliance-Anforderungen für Veröffentlichung oder Release sind definiert und verstanden.", "description": "Legal, privacy, and compliance requirements for publishing are defined and understood." } ], "baseTitle": "Monitoring & Verbesserung", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "improving", "stakeholders": [ { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-community-engagement-strategies", "slug": "resources/api-community-engagement-strategies", "title": "Strategien für das Engagement der API-Gemeinschaft", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 103, "outcomes": [ "Besseres Verständnis der Grundsätze von Strategien zur Einbindung der API-Gemeinschaft", "Standardisierter Ansatz mit API-Strategien zur Einbindung der Gemeinschaft", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "metrics", "consumer-feedback", "incident-report", "roadmap" ] } ] }, { "id": "api-productization-cycle", "slug": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs.", "purpose": "API-fokussierte Method Journey für Teams, die bereits wissen, dass die vorgesehene Umsetzungsweise ein API-Produkt ist.", "audiences": [], "audienceStakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas", "role": "suggested-answer-owner" } ] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "lead", "responsibilities": [] }, { "id": "api-architect", "sourceKey": "api-architect", "sourceStakeholderId": "api-architect", "title": "API-Architekt", "description": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "involvement": "core", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "lead", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "lead", "responsibilities": [] }, { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "lead", "responsibilities": [] } ], "entryCriteria": [ "api-opportunity-documented", "consumer-segments-identified" ], "exitCriteria": [ "api-contract-tested", "api-ready-for-publishing", "api-documentation-ready" ], "entryCriteriaDetails": [ { "id": "api-opportunity-documented", "title": "Die Capability-Möglichkeit wurde identifiziert und dokumentiert.", "description": "Individual API opportunities are identified and documented." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." } ], "exitCriteriaDetails": [ { "id": "api-contract-tested", "title": "Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.", "description": "The API contract is tested and meets functional and non-functional requirements." }, { "id": "api-ready-for-publishing", "title": "Die Capability ist bereit, über den gewählten Bereitstellungsmechanismus veröffentlicht oder ausgeliefert zu werden.", "description": "The API is ready to be deployed and exposed through the intended gateways and environments." }, { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." } ], "questionnaireResources": [ { "stationId": "api-product-strategy", "stationTitle": "API-Produktstrategie", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas", "suggestedAnswerOwner": { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "API-Produktstrategie", "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas", "suggestedAnswerOwner": { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "API-Produktstrategie", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "suggestedAnswerOwner": { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "API-Produktstrategie", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "suggestedAnswerOwner": { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-platform-architecture", "stationTitle": "API-Plattformarchitektur", "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "suggestedAnswerOwner": { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-platform-architecture", "stationTitle": "API-Plattformarchitektur", "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "suggestedAnswerOwner": { "id": "api-architect", "sourceKey": "api-architect", "sourceStakeholderId": "api-architect", "title": "API-Architekt", "description": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "involvement": "core", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-platform-architecture", "stationTitle": "API-Plattformarchitektur", "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "suggestedAnswerOwner": { "id": "api-architect", "sourceKey": "api-architect", "sourceStakeholderId": "api-architect", "title": "API-Architekt", "description": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "involvement": "core", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] } } ], "stations": [ { "index": 1, "id": "api-product-strategy", "slug": "method/api-product-strategy", "icon": "strategy-outline", "title": "API-Produktstrategie", "description": "Bevor Sie etwas bauen, sollten Sie von Anfang an den Wert, die Benutzer und die Geschäftsziele Ihrer API definieren.", "whyItMatters": "Viele Unternehmen betrachten APIs als technische Projekte und nicht als Produkte. Das Ergebnis? Verwirrte Kunden, schlechte Akzeptanz und verschwendeter Aufwand.\n\nDiese 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.", "applyInWork": "Bereitstellung von Richtlinien und Vorlagen für die Erstellung von API-Geschäftsmodellen, Wertvorschlägen und Roadmaps.", "outcomes": [ "Ein klares API-Wertversprechen und eine klare Zielgruppe", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung" ], "steps": [ { "text": "Untersuchen Sie das Kunden- oder Partnerproblem, das Sie mit APIs lösen wollen. Zeichnen Sie die Stakeholder, deren Wege und Ergebnisse mithilfe der Customer Journey Canvas auf.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas" } ], "questions": [ "Untersuchen Sie das Kunden- oder Partnerproblem, das Sie mit APIs lösen wollen. Zeichnen Sie die Stakeholder, deren Wege und Ergebnisse mithilfe der Customer Journey Canvas auf.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Bereitstellung von Richtlinien und Vorlagen für die Erstellung von API-Geschäftsmodellen, Wertvorschlägen und Roadmaps.", "Viele Unternehmen betrachten APIs als technische Projekte und nicht als Produkte. Das Ergebnis? Verwirrte Kunden, schlechte Akzeptanz und verschwendeter Aufwand.\n\nDiese 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." ], "criteria": [ "metrics-feedback-available", "business-goals-defined", "market-research-done", "stakeholder-approval" ], "criteriaDetails": [ { "id": "metrics-feedback-available", "title": "Relevante Marktsignale, Feedback oder operative Erkenntnisse liegen vor, um diese Capability-Möglichkeit zu bewerten.", "description": "Relevant market signals, feedback, or operational insights are available to guide this API opportunity." }, { "id": "business-goals-defined", "title": "Die Geschäftsziele sind definiert.", "description": "Business goals are defined." }, { "id": "market-research-done", "title": "Die Marktrecherche identifiziert relevante Capability-Möglichkeiten.", "description": "Market research identifies API opportunities." }, { "id": "stakeholder-approval", "title": "Die relevanten Stakeholder stimmen zu, dass diese Capability-Möglichkeit weiter untersucht und priorisiert werden sollte.", "description": "Relevant stakeholders agree this API opportunity is worth exploring and prioritizing." } ], "baseTitle": "Strategie", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "stakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas", "role": "suggested-answer-owner" } ] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "apiValuePropositionCanvas", "slug": "resources/api-value-proposition-canvas", "title": "API Value Proposition Canvas", "description": "Richten Sie API-Funktionen an den Bedürfnissen der Benutzer aus, indem Sie Aufgaben, Schmerzen und Gewinne auf API-Produkte abbilden.", "category": "canvas", "icon": "dashboard-outline", "order": 2, "outcomes": [ "Fokussierte Funktionsentwicklung", "Ausrichtung auf die Bedürfnisse der Nutzer", "Verbesserte Zufriedenheit der API-Kunden" ], "steps": [ "Aufgaben der Benutzerreise auflisten", "Identifizierung von Merkmalen, die erwartete Gewinne liefern", "Merkmale zur Bewältigung von Herausforderungen definieren", "Zuordnung von Merkmalen zu API-Produkten" ], "canvasId": "apiValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "apiBusinessModelCanvas", "slug": "resources/api-business-model-canvas", "title": "API Business Model Canvas", "description": "Strategische Bewertung der API-Geschäftsfähigkeit durch Zuordnung von Wertangeboten, Kundensegmenten und Schlüsselressourcen.", "category": "canvas", "icon": "dashboard-outline", "order": 3, "outcomes": [ "Klare Geschäftsstrategie für APIs", "Identifizierung der wichtigsten Ressourcen und Partner", "Abstimmung der API-Funktionen auf die Unternehmensziele" ], "steps": [ "Fassen Sie das Wertversprechen der API zusammen", "Definition von Verbrauchersegmenten", "Ermittlung von Strategien für die Beziehungen zu Entwicklern", "Karte der Vertriebskanäle", "die wichtigsten Ressourcen und Aktivitäten zu dokumentieren", "Ermittlung der wichtigsten Partner und Interessengruppen", "Nutzen und Kosten aufzeigen" ], "canvasId": "apiBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "evidence": [ "design-artifact", "documentation", "research", "roadmap" ] }, { "index": 2, "id": "api-consumer-experience", "slug": "method/api-consumer-experience", "icon": "deployed-code-account-outline", "title": "API Consumer Experience", "description": "Stellen Sie sicher, dass Ihre API auffindbar, verständlich und nutzbar ist - vor und nach der Einführung.", "whyItMatters": "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.\n\nOhne einen klaren Erlebnisplan:\n- Großartige APIs bleiben ungenutzt\n- Teams verschwenden Zeit damit, zu raten, wie sie Ihre API verwenden sollen\n- Feedbackschleifen sind unterbrochen oder fehlen.\n\nDiese Station hilft Ihnen, Ihre API mit den Augen ihrer Nutzer zu sehen.", "applyInWork": "Bereitstellung von Richtlinien, Tools und Feedback-Mechanismen für das Verständnis, die Analyse und die Verbesserung der internen und externen Erfahrungen von Entwicklern und Partnern.", "outcomes": [ "Identifizieren und priorisieren Sie Ihre Nutzer", "Definieren Sie die API-Erlebnisreise", "Onboarding, Dokumentation und Feedback planen", "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)" ], "steps": [ { "text": "Überprüfen Sie das bestehende API Value Proposition Canvаs von der Perspektive des Nutzers. Stellen Sie die Stabilität der unterstützten Geschäftsprozesse sicher und ergänzen Sie die Funktionen, die Probleme lösen und Vorteile bieten, um die Bedürfnisse der Nutzer zu berücksichtigen, damit diese spätere Designentscheidungen leiten können.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null } ], "questions": [ "Überprüfen Sie das bestehende API Value Proposition Canvаs von der Perspektive des Nutzers. Stellen Sie die Stabilität der unterstützten Geschäftsprozesse sicher und ergänzen Sie die Funktionen, die Probleme lösen und Vorteile bieten, um die Bedürfnisse der Nutzer zu berücksichtigen, damit diese spätere Designentscheidungen leiten können.", "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "Bereitstellung von Richtlinien, Tools und Feedback-Mechanismen für das Verständnis, die Analyse und die Verbesserung der internen und externen Erfahrungen von Entwicklern und Partnern.", "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.\n\nOhne einen klaren Erlebnisplan:\n- Großartige APIs bleiben ungenutzt\n- Teams verschwenden Zeit damit, zu raten, wie sie Ihre API verwenden sollen\n- Feedbackschleifen sind unterbrochen oder fehlen.\n\nDiese Station hilft Ihnen, Ihre API mit den Augen ihrer Nutzer zu sehen." ], "criteria": [ "api-opportunity-documented", "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-opportunity-documented", "title": "Die Capability-Möglichkeit wurde identifiziert und dokumentiert.", "description": "Individual API opportunities are identified and documented." }, { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "baseTitle": "Nutzeranforderungen & Onboarding", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "stakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "apiValuePropositionCanvas", "slug": "resources/api-value-proposition-canvas", "title": "API Value Proposition Canvas", "description": "Richten Sie API-Funktionen an den Bedürfnissen der Benutzer aus, indem Sie Aufgaben, Schmerzen und Gewinne auf API-Produkte abbilden.", "category": "canvas", "icon": "dashboard-outline", "order": 2, "outcomes": [ "Fokussierte Funktionsentwicklung", "Ausrichtung auf die Bedürfnisse der Nutzer", "Verbesserte Zufriedenheit der API-Kunden" ], "steps": [ "Aufgaben der Benutzerreise auflisten", "Identifizierung von Merkmalen, die erwartete Gewinne liefern", "Merkmale zur Bewältigung von Herausforderungen definieren", "Zuordnung von Merkmalen zu API-Produkten" ], "canvasId": "apiValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "design-artifact", "documentation", "consumer-feedback" ] }, { "index": 3, "id": "api-platform-architecture", "slug": "method/api-platform-architecture", "icon": "code-blocks-outline", "title": "API-Plattformarchitektur", "description": "Gewährleisten Sie Skalierbarkeit, Wiederverwendung und Governance für Ihre API- und Plattformkomponenten.", "whyItMatters": "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.", "applyInWork": "Aufbau einer skalierbaren, sicheren und konformen Infrastruktur für den API-Betrieb. Bereitstellung von Leitlinien für bewährte Architekturverfahren.", "outcomes": [ "Redundante APIs abbauen und die Kosten für die Cloud-Plattform senken", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit" ], "steps": [ { "text": "Das Business Impact Canvas hilft dabei, Risiken in Bezug auf API-Verfügbarkeit, -Sicherheit und -Funktionalität zu identifizieren und zu mindern, um fundierte Architekturentscheidungen zu unterstützen.", "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas" }, { "text": "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas" }, { "text": "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas" }, { "text": "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null } ], "questions": [ "Das Business Impact Canvas hilft dabei, Risiken in Bezug auf API-Verfügbarkeit, -Sicherheit und -Funktionalität zu identifizieren und zu mindern, um fundierte Architekturentscheidungen zu unterstützen.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Aufbau einer skalierbaren, sicheren und konformen Infrastruktur für den API-Betrieb. Bereitstellung von Leitlinien für bewährte Architekturverfahren.", "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." ], "criteria": [ "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "baseTitle": "Architektur & Plattformentscheidungen", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "architecture", "stakeholders": [ { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "lead", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "role": "suggested-answer-owner" } ] }, { "id": "api-architect", "sourceKey": "api-architect", "sourceStakeholderId": "api-architect", "title": "API-Architekt", "description": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "involvement": "core", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "architecture-decision", "documentation", "platform-config", "metrics" ] }, { "index": 4, "id": "api-design", "slug": "method/api-design", "icon": "api", "title": "API-Design", "description": "Erstellen Sie API-Designs, die konsistent, wiederverwendbar und auf Geschäftszielen und gemeinsamen Standards basieren.", "whyItMatters": "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.", "applyInWork": "Bereitstellung von wiederverwendbaren Designmustern, gemeinsamen Standards und Validierungstools für API-Spezifikationen. Sicherstellen, dass Designentscheidungen konsistent, frühzeitig überprüft und auf die Geschäftsabsicht ausgerichtet sind.", "outcomes": [ "Gut dokumentierte und konsistente API-Designs", "Wiederverwendbare und validierte API-Schnittstellenverträge", "Entwürfe, die auf Domänenmodelle und Interaktionsmuster abgestimmt sind", "Rückverfolgbarkeit des Designs zum Geschäftswert" ], "steps": [ { "text": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "resourceId": "interactionCanvas", "resourceTitle": "Interaction Canvas", "canvasId": "interactionCanvas" }, { "text": "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "restCanvas", "resourceTitle": "REST Canvas", "canvasId": "restCanvas" }, { "text": "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "eventCanvas", "resourceTitle": "Event Canvas", "canvasId": "eventCanvas" }, { "text": "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "graphqlCanvas", "resourceTitle": "GraphQL Canvas", "canvasId": "graphqlCanvas" }, { "text": "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "resourceId": "api-design-principles", "resourceTitle": "API Design Prinzipien", "canvasId": null }, { "text": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den API-Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "resourceId": "contract-first-design", "resourceTitle": "Vertrag Erstes Design", "canvasId": null }, { "text": "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen.", "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den API-Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Bereitstellung von wiederverwendbaren Designmustern, gemeinsamen Standards und Validierungstools für API-Spezifikationen. Sicherstellen, dass Designentscheidungen konsistent, frühzeitig überprüft und auf die Geschäftsabsicht ausgerichtet sind.", "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." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "baseTitle": "Lösungs- & Schnittstellendesign", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "design", "stakeholders": [ { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "lead", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "restCanvas", "slug": "resources/rest-canvas", "title": "REST Canvas", "description": "Entwurf von APIs unter Verwendung von RESTful-Prinzipien, Definition von Ressourcen, Verben und Beispielanforderungen und -antworten.", "category": "canvas", "icon": "dashboard-outline", "order": 10, "outcomes": [ "Einheitliches RESTful API-Design", "Definierte Ressourcen und ihre Interaktionen", "Beispielhafte Anfragen und Antworten zur Verdeutlichung" ], "steps": [ "Identifizierung der wichtigsten Ressourcen, die von der API bereitgestellt werden", "Definieren Sie die Struktur des API-Ressourcenmodells", "Angabe von HTTP-Verben für die Interaktion mit Ressourcen", "Geben Sie Beispiele für Anfragen und Antworten für jedes Verb an." ], "canvasId": "restCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "eventCanvas", "slug": "resources/event-canvas", "title": "Event Canvas", "description": "Entwerfen Sie ereignisgesteuerte APIs, indem Sie Ereignisse, Auslöser und Verarbeitungslogik definieren.", "category": "canvas", "icon": "dashboard-outline", "order": 12, "outcomes": [ "Definierte ereignisgesteuerte Architektur", "Ereignisauslöser und Verarbeitungslogik löschen", "Verbesserte Reaktionsfähigkeit auf Änderungen in Echtzeit" ], "steps": [ "Identifizierung von Schlüsselereignissen im System", "Definieren Sie Auslöser für jedes Ereignis", "Beschreiben Sie die Backend-Verarbeitungslogik für Ereignisse", "Angabe der resultierenden Ausgaben oder Bestätigungen" ], "canvasId": "eventCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "graphqlCanvas", "slug": "resources/graphql-canvas", "title": "GraphQL Canvas", "description": "Entwerfen Sie GraphQL-APIs, indem Sie Typen, Abfragen, Mutationen und Abonnements definieren.", "category": "canvas", "icon": "dashboard-outline", "order": 11, "outcomes": [ "Strukturierter GraphQL-API-Entwurf", "Definierte Typen und ihre Beziehungen", "Abfragen, Mutationen und Abonnements löschen" ], "steps": [ "Welche Probleme versuchen die API-Kunden zu lösen? Welche Daten benötigen sie?", "Definieren Sie GraphQL-Typen und ihre Attribute: Was sind die wichtigsten Typen (z. B. Benutzer, Bestellung, Produkt)?", "Beziehungen zwischen Typen abbilden: Wie stehen die Typen in verschachtelten Abfragen zueinander?", "Abfragen für den Datenabruf spezifizieren", "Definieren Sie Mutationen für Datenänderungen: Durch welche Operationen werden Daten verändert (z. B. Erstellen, Aktualisieren, Löschen)?", "Übersichtsabonnements für Echtzeit-Updates", "Definieren Sie Authentifizierung und Autorisierung: Wer darf auf welche Felder oder Typen zugreifen?", "Überlegen Sie, ob es Einschränkungen in Bezug auf Paginierung, Filterung oder Ratenbegrenzung gibt." ], "canvasId": "graphqlCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-design-principles", "slug": "resources/api-design-principles", "title": "API Design Prinzipien", "description": "Ein prägnanter Leitfaden zu API-Benutzerfreundlichkeit, Auffindbarkeit und Konsistenz, der auf gemeinsamen Designregeln und echten Kundenbedürfnissen basiert.", "category": "guideline", "icon": "edit-document-outline", "order": 14, "outcomes": [ "Besseres Verständnis der API-Gestaltungsgrundsätze", "Standardisierter Ansatz mit API Design Prinzipien", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "**Consumer-first design:** Wir beginnen jeden APIOps-Zyklus mit der Erfassung von Benutzerzielen und Fachbegriffen, damit APIs echte Probleme lösen.", "**Konsistente Benennung und Verhalten:** Anwendung gemeinsamer Konventionen für Ressourcen, Fehler und Formate, um APIs vorhersehbar zu machen.", "**Vertragsgesteuert:** Erfassen Sie die Schnittstelle mit OpenAPI oder AsyncAPI vor der Codierung, um die Teams aufeinander abzustimmen und Automatisierung zu ermöglichen.", "**Benutzerfreundlichkeit und Auffindbarkeit:** Bereitstellung einer klaren Dokumentation und von Beispielen, damit Entwickler schnell verstehen, wie die API zu verwenden ist.", "**Sicher iterieren:** Entwürfe in kleinen, abgestuften Schritten weiterentwickeln, damit Änderungen die bestehenden Kunden nicht stören." ], "canvasId": null, "sourcePath": "src/snippets/api-style-guide.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"hides-raw-backend-data\",\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}", "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true } ], "evidence": [ "spec", "contract", "design-artifact", "documentation" ] }, { "index": 5, "id": "api-delivery", "slug": "method/api-delivery", "icon": "code", "title": "API-Bereitstellung", "description": "Erstellen, Testen und Freigeben von APIs unter Verwendung moderner Bereitstellungspipelines und bewährter technischer Verfahren.", "whyItMatters": "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.", "applyInWork": "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.", "outcomes": [ "APIs, die mit getesteten Frameworks und Mustern implementiert werden", "Zuverlässige und automatisierte CI/CD-Pipelines", "Funktionale und nicht-funktionale Tests integriert", "Sichere und gesetzeskonforme Bereitstellungspipelines" ], "steps": [ { "text": "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.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Erstellen Sie die API-Implementierung auf Basis des validierten Schnittstellenvertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "resourceId": "api-testing-best-practices", "resourceTitle": "Bewährte Praktiken für API-Tests", "canvasId": null }, { "text": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "resourceId": "api-security-best-practices", "resourceTitle": "Bewährte Praktiken für die API-Sicherheit", "canvasId": null }, { "text": "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.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "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." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "baseTitle": "Bereitstellung & Betrieb", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "delivery", "stakeholders": [ { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "lead", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-security-best-practices", "slug": "resources/api-security-best-practices", "title": "Bewährte Praktiken für die API-Sicherheit", "description": "Eine Reihe praktikabler Kontrollen zur Sicherung von APIs, einschließlich Authentifizierung, Autorisierung, Verschlüsselung, Ratenbegrenzung und Konformitätsprüfungen auf Pipeline-Ebene.", "category": "guideline", "icon": "edit-document-outline", "order": 130, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Sicherheitspraktiken", "Standardisierter Ansatz mit bewährten API-Sicherheitspraktiken", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "Implementieren Sie Sicherheitsmaßnahmen wie Authentifizierung, Autorisierung, Verschlüsselung und Ratenbegrenzung, um APIs vor Bedrohungen zu schützen.", "Implementieren Sie automatisierte Sicherheitsprüfungen und Compliance-Validierungen in der CI/CD-Pipeline, um sicherzustellen, dass APIs sicher und konform sind." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "implementation", "pipeline-config", "test-report", "security-report" ] }, { "index": 6, "id": "api-audit", "slug": "method/api-audit", "icon": "check-box-outline", "title": "API-Audit", "description": "Stellen Sie sicher, dass APIs vor der Veröffentlichung und Bereitstellung den geschäftlichen, gestalterischen und betrieblichen Standards entsprechen.", "whyItMatters": "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.", "applyInWork": "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.", "outcomes": [ "APIs erfüllen interne und externe Standards", "Klare Dokumentation des API-Designs und der Implementierungsentscheidungen", "Sicherheit, Leistung und Compliance validiert", "Geringeres Risiko von Problemen in der Produktion" ], "steps": [ { "text": "Führen Sie Audits durch, um sicherzustellen, dass APIs vor der Veröffentlichung organisatorische, technische und rechtliche Standards erfüllen.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null }, { "text": "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.", "resourceId": "api-compliance-best-practices", "resourceTitle": "Bewährte Praktiken zur API-Einhaltung", "canvasId": null }, { "text": "Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.", "resourceTitle": "", "canvasId": null } ], "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." ], "criteria": [ "architecture-patterns-validated", "design-reflects-business-value", "api-description-available", "api-consistency", "api-contract-tested" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-description-available", "title": "Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.", "description": "The API and its exposed capabilities are described clearly enough for review, audit, and onboarding." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." }, { "id": "api-contract-tested", "title": "Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.", "description": "The API contract is tested and meets functional and non-functional requirements." } ], "baseTitle": "Qualitäts- & Bereitschaftssicherung", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "stakeholders": [ { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "lead", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false }, { "id": "api-compliance-best-practices", "slug": "resources/api-compliance-best-practices", "title": "Bewährte Praktiken zur API-Einhaltung", "description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 104, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "audit-report", "compliance-report", "security-report", "test-report" ] }, { "index": 7, "id": "api-publishing", "slug": "method/api-publishing", "icon": "deployed-code-outline", "title": "API-Veröffentlichung", "description": "Stellen Sie APIs mit der richtigen Dokumentation und den richtigen Prozessen sicher und klar für die richtige Zielgruppe bereit.", "whyItMatters": "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.", "applyInWork": "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.", "outcomes": [ "Veröffentlichung von APIs in der richtigen Umgebung (privat, Partner, öffentlich)", "Klare API-Einführungs- und Registrierungsprozesse", "Dokumentation, Sicherheitsmodelle und Richtlinien verfügbar", "APIs bereit für Skalierung und Governance" ], "steps": [ { "text": "Veröffentlichen Sie APIs in den entsprechenden Gateways und Umgebungen, um die Wiederverwendbarkeit für mehrere Nutzer zu unterstützen.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null }, { "text": "Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "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." ], "criteria": [ "audit-passed", "audit-reports-shared", "api-ready-for-publishing", "api-documentation-ready" ], "criteriaDetails": [ { "id": "audit-passed", "title": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "description": "The API passes compliance, security, and audit checks." }, { "id": "audit-reports-shared", "title": "Audit-Ergebnisse und Maßnahmenentscheidungen wurden mit den relevanten Stakeholdern geteilt.", "description": "Audit findings and remediation decisions are shared with the relevant stakeholders." }, { "id": "api-ready-for-publishing", "title": "Die Capability ist bereit, über den gewählten Bereitstellungsmechanismus veröffentlicht oder ausgeliefert zu werden.", "description": "The API is ready to be deployed and exposed through the intended gateways and environments." }, { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." } ], "baseTitle": "Veröffentlichung & Enablement", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "stakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false } ], "evidence": [ "gateway-config", "developer-portal", "documentation", "release-record" ] }, { "index": 8, "id": "monitoring-and-improving", "slug": "method/monitoring-and-improving", "icon": "analytics-outline", "title": "API-Monitoring & Verbesserung", "description": "Nutzen Sie Messgrößen und Feedback, um die API-Leistung zu verfolgen und kontinuierliche Verbesserungen voranzutreiben.", "whyItMatters": "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.", "applyInWork": "Einrichtung von Analyserahmen zur Verfolgung von Leistung und Engagement. Entwickeln Sie Feedbackschleifen, Analysetools und Engagementstrategien für APIs.", "outcomes": [ "Festlegung und Verfolgung von Leistungs- und Nutzungskennzahlen", "Feedback-Schleifen für Entwickler sind vorhanden", "Kontinuierlich ermittelte und behandelte Probleme", "Iteration der API, abgestimmt auf die Bedürfnisse der Nutzer" ], "steps": [ { "text": "Überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Akzeptanzmetriken (z. B. NPS).", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null }, { "text": "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null }, { "text": "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null } ], "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." ], "criteria": [ "api-documentation-ready", "consumer-support-ready", "legal-compliance-clear" ], "criteriaDetails": [ { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." }, { "id": "consumer-support-ready", "title": "Onboarding-, Support- und Kommunikationsprozesse für Nutzer sind bereit.", "description": "Registration, support, and communication processes are ready for API consumers." }, { "id": "legal-compliance-clear", "title": "Rechtliche, Datenschutz- und Compliance-Anforderungen für Veröffentlichung oder Release sind definiert und verstanden.", "description": "Legal, privacy, and compliance requirements for publishing are defined and understood." } ], "baseTitle": "Monitoring & Verbesserung", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "improving", "stakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "core", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-community-engagement-strategies", "slug": "resources/api-community-engagement-strategies", "title": "Strategien für das Engagement der API-Gemeinschaft", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 103, "outcomes": [ "Besseres Verständnis der Grundsätze von Strategien zur Einbindung der API-Gemeinschaft", "Standardisierter Ansatz mit API-Strategien zur Einbindung der Gemeinschaft", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "metrics", "consumer-feedback", "incident-report", "roadmap" ] } ] }, { "id": "integration-productization-cycle", "slug": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird.", "purpose": "Unterstuetzt das Design wiederverwendbarer Integrations-Capabilities, bevor ein API-, Event-, Datei-, Stream-, Datenprodukt-, direkte Integrations- oder hybrider Implementierungsstil gewaehlt wird.", "audiences": [], "audienceStakeholders": [ { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "lead", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "lead", "responsibilities": [ { "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "lead", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "lead", "responsibilities": [] }, { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "lead", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] } ], "entryCriteria": [ "business-goals-defined", "api-opportunity-documented" ], "exitCriteria": [ "architecture-patterns-validated", "api-description-available", "audit-passed" ], "entryCriteriaDetails": [ { "id": "business-goals-defined", "title": "Die Geschäftsziele sind definiert.", "description": "Business goals are defined." }, { "id": "api-opportunity-documented", "title": "Die Capability-Möglichkeit wurde identifiziert und dokumentiert.", "description": "Individual API opportunities are identified and documented." } ], "exitCriteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "api-description-available", "title": "Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.", "description": "The API and its exposed capabilities are described clearly enough for review, audit, and onboarding." }, { "id": "audit-passed", "title": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "description": "The API passes compliance, security, and audit checks." } ], "questionnaireResources": [ { "stationId": "api-product-strategy", "stationTitle": "Integrations-Capability-Strategie", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "suggestedAnswerOwner": { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "Integrations-Capability-Strategie", "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "suggestedAnswerOwner": { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "Integrations-Capability-Strategie", "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "suggestedAnswerOwner": { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "Integrations-Capability-Strategie", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "suggestedAnswerOwner": { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-consumer-experience", "stationTitle": "Integrationsnutzeranforderungen & Onboarding", "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "suggestedAnswerOwner": { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "lead", "responsibilities": [ { "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-platform-architecture", "stationTitle": "Integrationsarchitektur & Plattformentscheidungen", "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "suggestedAnswerOwner": { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "lead", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-platform-architecture", "stationTitle": "Integrationsarchitektur & Plattformentscheidungen", "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "suggestedAnswerOwner": { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [ { "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-platform-architecture", "stationTitle": "Integrationsarchitektur & Plattformentscheidungen", "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "suggestedAnswerOwner": { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [ { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] } } ], "stations": [ { "index": 1, "id": "api-product-strategy", "slug": "method/api-product-strategy", "icon": "strategy-outline", "title": "Integrations-Capability-Strategie", "description": "Rahmen Sie die wiederverwendbare Integrations-Capability, den Geschaeftsbedarf, Ownership und erwartete Wiederverwendung, bevor der Implementierungsstil gewaehlt wird.", "whyItMatters": "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden.", "applyInWork": "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "outcomes": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung" ], "steps": [ { "text": "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas" } ], "questions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "criteria": [ "metrics-feedback-available", "business-goals-defined", "market-research-done", "stakeholder-approval" ], "criteriaDetails": [ { "id": "metrics-feedback-available", "title": "Relevante Marktsignale, Feedback oder operative Erkenntnisse liegen vor, um diese Capability-Möglichkeit zu bewerten.", "description": "Relevant market signals, feedback, or operational insights are available to guide this API opportunity." }, { "id": "business-goals-defined", "title": "Die Geschäftsziele sind definiert.", "description": "Business goals are defined." }, { "id": "market-research-done", "title": "Die Marktrecherche identifiziert relevante Capability-Möglichkeiten.", "description": "Market research identifies API opportunities." }, { "id": "stakeholder-approval", "title": "Die relevanten Stakeholder stimmen zu, dass diese Capability-Möglichkeit weiter untersucht und priorisiert werden sollte.", "description": "Relevant stakeholders agree this API opportunity is worth exploring and prioritizing." } ], "baseTitle": "Strategie", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "stakeholders": [ { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "lead", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "consulted", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "evidence": [ "design-artifact", "documentation", "research", "roadmap" ] }, { "index": 2, "id": "api-consumer-experience", "slug": "method/api-consumer-experience", "icon": "deployed-code-account-outline", "title": "Integrationsnutzeranforderungen & Onboarding", "description": "Erfassen Sie Integrationsnutzer, Anbieter-Verantwortlichkeiten, Onboarding-Bedarf, Serviceerwartungen und operative Einschränkungen.", "whyItMatters": "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab.", "applyInWork": "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "outcomes": [ "Explizite Nutzeranforderungen und Onboarding-Erwartungen", "Definieren Sie die API-Erlebnisreise", "Onboarding, Dokumentation und Feedback planen", "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)" ], "steps": [ { "text": "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null } ], "questions": [ "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab." ], "criteria": [ "api-opportunity-documented", "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-opportunity-documented", "title": "Die Capability-Möglichkeit wurde identifiziert und dokumentiert.", "description": "Individual API opportunities are identified and documented." }, { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "baseTitle": "Nutzeranforderungen & Onboarding", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "stakeholders": [ { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "lead", "responsibilities": [ { "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "core", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "consulted", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "design-artifact", "documentation", "consumer-feedback" ] }, { "index": 3, "id": "api-platform-architecture", "slug": "method/api-platform-architecture", "icon": "code-blocks-outline", "title": "Integrationsarchitektur & Plattformentscheidungen", "description": "Waehlen Sie Integrationsarchitektur, Implementierungsstil und Plattformfaehigkeiten unter Beruecksichtigung von Einschraenkungen und Governance-Modell.", "whyItMatters": "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen.", "applyInWork": "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "outcomes": [ "Validierte Architektur- und Plattformentscheidung", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit" ], "steps": [ { "text": "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas" }, { "text": "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas" }, { "text": "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas" }, { "text": "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null } ], "questions": [ "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen." ], "criteria": [ "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "baseTitle": "Architektur & Plattformentscheidungen", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "architecture", "stakeholders": [ { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "lead", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [ { "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "role": "suggested-answer-owner" } ] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [ { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-architect", "sourceKey": "api-architect", "sourceStakeholderId": "api-architect", "title": "API-Architekt", "description": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "partner-integration-guidelines", "slug": "resources/partner-integration-guidelines", "title": "Leitlinien für die Integration von Partnern", "description": "Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.", "category": "guideline", "icon": "edit-document-outline", "order": 164, "outcomes": [ "Besseres Verständnis der Grundsätze der Leitlinien für die Integration von Partnern", "Standardisierter Ansatz unter Verwendung der Richtlinien zur Partnerintegration", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Festlegung von Integrationsprozessen und Richtlinien für die Zusammenarbeit mit Partnern, einschließlich technischer Integration, Datenaustausch und Unterstützung.", "Überwachen Sie die API-Leistung und -Einhaltung der Partner, um Zuverlässigkeit und Übereinstimmung mit Ihrer API-Strategie zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "architecture-decision", "documentation", "platform-config", "metrics" ] }, { "index": 4, "id": "api-design", "slug": "method/api-design", "icon": "api", "title": "Integrationsdesign", "description": "Entwerfen Sie Schnittstellenvertrag, Schemas, Payloads und Interaktionsmuster fuer den gewaehlten Integrationsstil.", "whyItMatters": "Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist.", "applyInWork": "Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.", "outcomes": [ "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise", "Wiederverwendbare und validierte Schnittstellenverträge", "Entwürfe, die auf Domänenmodelle und Interaktionsmuster abgestimmt sind", "Rückverfolgbarkeit des Designs zum Geschäftswert" ], "steps": [ { "text": "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "resourceId": "interactionCanvas", "resourceTitle": "Interaction Canvas", "canvasId": "interactionCanvas" }, { "text": "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "restCanvas", "resourceTitle": "REST Canvas", "canvasId": "restCanvas" }, { "text": "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "eventCanvas", "resourceTitle": "Event Canvas", "canvasId": "eventCanvas" }, { "text": "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "graphqlCanvas", "resourceTitle": "GraphQL Canvas", "canvasId": "graphqlCanvas" }, { "text": "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "resourceId": "api-design-principles", "resourceTitle": "API Design Prinzipien", "canvasId": null }, { "text": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "resourceId": "contract-first-design", "resourceTitle": "Vertrag Erstes Design", "canvasId": null }, { "text": "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.", "Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "baseTitle": "Lösungs- & Schnittstellendesign", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "design", "stakeholders": [ { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "lead", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "integration-style-selection-guide", "slug": "resources/integration-style-selection-guide", "title": "Leitfaden zur Auswahl des Implementierungsstils", "description": "Orientierung zur Auswahl zwischen API, Event, Datei, Stream, Datenprodukt, direkter Integration oder hybriden Implementierungsstilen auf Grundlage von Anforderungen und Rahmenbedingungen.", "category": "guideline", "icon": "edit-document-outline", "order": 180, "outcomes": [ "Begründeter Implementierungsstil für die Integration", "Abwägungen zwischen den Optionen für den Implementierungsstil dokumentiert", "Ausgewählter Stil auf Anforderungen von Nutzern, Plattform, Daten und Betrieb zurückführbar" ], "steps": [ "Vergleichen Sie tragfähige Implementierungsstile anhand von Latenz, Volumen, Kopplung, Datenverantwortung, Aktualität, Governance und Betriebsfähigkeit.", "Identifizieren Sie, wann API, Event, Datei, Stream, Datenprodukt, direkte Integration oder hybride Ansätze zum Anwendungsfall passen.", "Dokumentieren Sie Einschränkungen, Risiken und Plattformabhängigkeiten für den ausgewählten Implementierungsstil.", "Halten Sie fest, warum verworfene Alternativen nicht ausgewählt wurden." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "restCanvas", "slug": "resources/rest-canvas", "title": "REST Canvas", "description": "Entwurf von APIs unter Verwendung von RESTful-Prinzipien, Definition von Ressourcen, Verben und Beispielanforderungen und -antworten.", "category": "canvas", "icon": "dashboard-outline", "order": 10, "outcomes": [ "Einheitliches RESTful API-Design", "Definierte Ressourcen und ihre Interaktionen", "Beispielhafte Anfragen und Antworten zur Verdeutlichung" ], "steps": [ "Identifizierung der wichtigsten Ressourcen, die von der API bereitgestellt werden", "Definieren Sie die Struktur des API-Ressourcenmodells", "Angabe von HTTP-Verben für die Interaktion mit Ressourcen", "Geben Sie Beispiele für Anfragen und Antworten für jedes Verb an." ], "canvasId": "restCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "eventCanvas", "slug": "resources/event-canvas", "title": "Event Canvas", "description": "Entwerfen Sie ereignisgesteuerte APIs, indem Sie Ereignisse, Auslöser und Verarbeitungslogik definieren.", "category": "canvas", "icon": "dashboard-outline", "order": 12, "outcomes": [ "Definierte ereignisgesteuerte Architektur", "Ereignisauslöser und Verarbeitungslogik löschen", "Verbesserte Reaktionsfähigkeit auf Änderungen in Echtzeit" ], "steps": [ "Identifizierung von Schlüsselereignissen im System", "Definieren Sie Auslöser für jedes Ereignis", "Beschreiben Sie die Backend-Verarbeitungslogik für Ereignisse", "Angabe der resultierenden Ausgaben oder Bestätigungen" ], "canvasId": "eventCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "graphqlCanvas", "slug": "resources/graphql-canvas", "title": "GraphQL Canvas", "description": "Entwerfen Sie GraphQL-APIs, indem Sie Typen, Abfragen, Mutationen und Abonnements definieren.", "category": "canvas", "icon": "dashboard-outline", "order": 11, "outcomes": [ "Strukturierter GraphQL-API-Entwurf", "Definierte Typen und ihre Beziehungen", "Abfragen, Mutationen und Abonnements löschen" ], "steps": [ "Welche Probleme versuchen die API-Kunden zu lösen? Welche Daten benötigen sie?", "Definieren Sie GraphQL-Typen und ihre Attribute: Was sind die wichtigsten Typen (z. B. Benutzer, Bestellung, Produkt)?", "Beziehungen zwischen Typen abbilden: Wie stehen die Typen in verschachtelten Abfragen zueinander?", "Abfragen für den Datenabruf spezifizieren", "Definieren Sie Mutationen für Datenänderungen: Durch welche Operationen werden Daten verändert (z. B. Erstellen, Aktualisieren, Löschen)?", "Übersichtsabonnements für Echtzeit-Updates", "Definieren Sie Authentifizierung und Autorisierung: Wer darf auf welche Felder oder Typen zugreifen?", "Überlegen Sie, ob es Einschränkungen in Bezug auf Paginierung, Filterung oder Ratenbegrenzung gibt." ], "canvasId": "graphqlCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true } ], "evidence": [ "spec", "contract", "design-artifact", "documentation" ] }, { "index": 5, "id": "api-delivery", "slug": "method/api-delivery", "icon": "code", "title": "Integrationsbereitstellung & Betrieb", "description": "Bauen, testen, automatisieren, deployen und betreiben Sie die Integrations-Capability mit dem gewaehlten Implementierungsstil und dem validierten Schnittstellenvertrag.", "whyItMatters": "Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird.", "applyInWork": "Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.", "outcomes": [ "Eine bereitgestellte Capability, die mit dem validierten Schnittstellenvertrag übereinstimmt", "Zuverlässige und automatisierte CI/CD-Pipelines", "Funktionale und nicht-funktionale Tests integriert", "Sichere und gesetzeskonforme Bereitstellungspipelines" ], "steps": [ { "text": "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "resourceId": "api-testing-best-practices", "resourceTitle": "Bewährte Praktiken für API-Tests", "canvasId": null }, { "text": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "resourceId": "api-security-best-practices", "resourceTitle": "Bewährte Praktiken für die API-Sicherheit", "canvasId": null }, { "text": "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.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags 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.", "Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.", "Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "baseTitle": "Bereitstellung & Betrieb", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "delivery", "stakeholders": [ { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "lead", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-security-best-practices", "slug": "resources/api-security-best-practices", "title": "Bewährte Praktiken für die API-Sicherheit", "description": "Eine Reihe praktikabler Kontrollen zur Sicherung von APIs, einschließlich Authentifizierung, Autorisierung, Verschlüsselung, Ratenbegrenzung und Konformitätsprüfungen auf Pipeline-Ebene.", "category": "guideline", "icon": "edit-document-outline", "order": 130, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Sicherheitspraktiken", "Standardisierter Ansatz mit bewährten API-Sicherheitspraktiken", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "Implementieren Sie Sicherheitsmaßnahmen wie Authentifizierung, Autorisierung, Verschlüsselung und Ratenbegrenzung, um APIs vor Bedrohungen zu schützen.", "Implementieren Sie automatisierte Sicherheitsprüfungen und Compliance-Validierungen in der CI/CD-Pipeline, um sicherzustellen, dass APIs sicher und konform sind." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "partner-integration-guidelines", "slug": "resources/partner-integration-guidelines", "title": "Leitlinien für die Integration von Partnern", "description": "Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.", "category": "guideline", "icon": "edit-document-outline", "order": 164, "outcomes": [ "Besseres Verständnis der Grundsätze der Leitlinien für die Integration von Partnern", "Standardisierter Ansatz unter Verwendung der Richtlinien zur Partnerintegration", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Festlegung von Integrationsprozessen und Richtlinien für die Zusammenarbeit mit Partnern, einschließlich technischer Integration, Datenaustausch und Unterstützung.", "Überwachen Sie die API-Leistung und -Einhaltung der Partner, um Zuverlässigkeit und Übereinstimmung mit Ihrer API-Strategie zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "implementation", "pipeline-config", "test-report", "security-report" ] }, { "index": 6, "id": "api-audit", "slug": "method/api-audit", "icon": "check-box-outline", "title": "Integrationsbereitschaftssicherung", "description": "Sichern Sie Integrationsbereitschaft, Governance, Qualität, Sicherheit, Compliance und operative Nachweise vor der Veröffentlichung ab.", "whyItMatters": "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung.", "applyInWork": "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "outcomes": [ "Dokumentierte Bereitschaft für Veröffentlichung und Wiederverwendung", "Klare Dokumentation des API-Designs und der Implementierungsentscheidungen", "Sicherheit, Leistung und Compliance validiert", "Geringeres Risiko von Problemen in der Produktion" ], "steps": [ { "text": "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null }, { "text": "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.", "resourceId": "api-compliance-best-practices", "resourceTitle": "Bewährte Praktiken zur API-Einhaltung", "canvasId": null }, { "text": "Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.", "resourceTitle": "", "canvasId": null } ], "questions": [ "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "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.", "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung." ], "criteria": [ "architecture-patterns-validated", "design-reflects-business-value", "api-description-available", "api-consistency", "api-contract-tested" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-description-available", "title": "Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.", "description": "The API and its exposed capabilities are described clearly enough for review, audit, and onboarding." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." }, { "id": "api-contract-tested", "title": "Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.", "description": "The API contract is tested and meets functional and non-functional requirements." } ], "baseTitle": "Qualitäts- & Bereitschaftssicherung", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "stakeholders": [ { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "lead", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false }, { "id": "api-compliance-best-practices", "slug": "resources/api-compliance-best-practices", "title": "Bewährte Praktiken zur API-Einhaltung", "description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 104, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "audit-report", "compliance-report", "security-report", "test-report" ] }, { "index": 7, "id": "api-publishing", "slug": "method/api-publishing", "icon": "deployed-code-outline", "title": "Integrationsveroeffentlichung & Enablement", "description": "Veroeffentlichen Sie die Integrations-Capability, damit Teams sie finden, bewerten, Zugriff beantragen, das Onboarding abschliessen, wiederverwenden und Support erhalten koennen.", "whyItMatters": "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen.", "applyInWork": "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "outcomes": [ "Eine auffindbare und nutzbare Capability", "Klare API-Einführungs- und Registrierungsprozesse", "Dokumentation, Sicherheitsmodelle und Richtlinien verfügbar", "APIs bereit für Skalierung und Governance" ], "steps": [ { "text": "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null }, { "text": "Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "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.", "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen." ], "criteria": [ "audit-passed", "audit-reports-shared", "api-ready-for-publishing", "api-documentation-ready" ], "criteriaDetails": [ { "id": "audit-passed", "title": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "description": "The API passes compliance, security, and audit checks." }, { "id": "audit-reports-shared", "title": "Audit-Ergebnisse und Maßnahmenentscheidungen wurden mit den relevanten Stakeholdern geteilt.", "description": "Audit findings and remediation decisions are shared with the relevant stakeholders." }, { "id": "api-ready-for-publishing", "title": "Die Capability ist bereit, über den gewählten Bereitstellungsmechanismus veröffentlicht oder ausgeliefert zu werden.", "description": "The API is ready to be deployed and exposed through the intended gateways and environments." }, { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." } ], "baseTitle": "Veröffentlichung & Enablement", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "stakeholders": [ { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "lead", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "service-agreement-template", "slug": "resources/service-agreement-template", "title": "Vorlage für eine Dienstleistungsvereinbarung", "description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "category": "guideline", "icon": "edit-document-outline", "order": 172, "outcomes": [ "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "gateway-config", "developer-portal", "documentation", "release-record" ] }, { "index": 8, "id": "monitoring-and-improving", "slug": "method/monitoring-and-improving", "icon": "analytics-outline", "title": "Integrationsmonitoring & Verbesserung", "description": "Überwachen Sie Integrationszuverlässigkeit, Wiederverwendung, Incidents, Performance, Nutzerergebnisse und Verbesserungsbedarf.", "whyItMatters": "Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern.", "applyInWork": "Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.", "outcomes": [ "Gemessene Capability-Gesundheit und Wertbeitrag", "Feedback-Schleifen für Entwickler sind vorhanden", "Kontinuierlich ermittelte und behandelte Probleme", "Iteration der API, abgestimmt auf die Bedürfnisse der Nutzer" ], "steps": [ { "text": "Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null }, { "text": "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null }, { "text": "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null } ], "questions": [ "Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.", "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.", "Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.", "Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern." ], "criteria": [ "api-documentation-ready", "consumer-support-ready", "legal-compliance-clear" ], "criteriaDetails": [ { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." }, { "id": "consumer-support-ready", "title": "Onboarding-, Support- und Kommunikationsprozesse für Nutzer sind bereit.", "description": "Registration, support, and communication processes are ready for API consumers." }, { "id": "legal-compliance-clear", "title": "Rechtliche, Datenschutz- und Compliance-Anforderungen für Veröffentlichung oder Release sind definiert und verstanden.", "description": "Legal, privacy, and compliance requirements for publishing are defined and understood." } ], "baseTitle": "Monitoring & Verbesserung", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "improving", "stakeholders": [ { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "lead", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "core", "responsibilities": [] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-community-engagement-strategies", "slug": "resources/api-community-engagement-strategies", "title": "Strategien für das Engagement der API-Gemeinschaft", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 103, "outcomes": [ "Besseres Verständnis der Grundsätze von Strategien zur Einbindung der API-Gemeinschaft", "Standardisierter Ansatz mit API-Strategien zur Einbindung der Gemeinschaft", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "metrics", "consumer-feedback", "incident-report", "roadmap" ] } ] }, { "id": "automation-cycle", "slug": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten.", "purpose": "Produktisieren Sie Automatisierungsmöglichkeiten zu gesteuerten Workflows mit klaren Nutzern, Plattformen, Kontrollen, Bereitstellungspfaden, Enablement und Monitoring.", "audiences": [], "audienceStakeholders": [ { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "lead", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "core", "responsibilities": [] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [ { "resourceId": "interactionCanvas", "resourceTitle": "Interaction Canvas", "canvasId": "interactionCanvas", "role": "suggested-answer-owner" } ] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "lead", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] } ], "entryCriteria": [ "business-goals-defined", "stakeholder-approval" ], "exitCriteria": [ "design-reflects-business-value", "automation-workflow-validated", "audit-passed" ], "entryCriteriaDetails": [ { "id": "business-goals-defined", "title": "Die Geschäftsziele sind definiert.", "description": "Business goals are defined." }, { "id": "stakeholder-approval", "title": "Die relevanten Stakeholder stimmen zu, dass diese Capability-Möglichkeit weiter untersucht und priorisiert werden sollte.", "description": "Relevant stakeholders agree this API opportunity is worth exploring and prioritizing." } ], "exitCriteriaDetails": [ { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "automation-workflow-validated", "title": "Workflow, Regeln, Integrationen und relevante Schnittstellenverträge wurden validiert und getestet.", "description": "The workflow, rules, integrations, and relevant interface contracts have been validated and tested." }, { "id": "audit-passed", "title": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "description": "The API passes compliance, security, and audit checks." } ], "questionnaireResources": [ { "stationId": "api-product-strategy", "stationTitle": "Automatisierungschance & Strategie", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "suggestedAnswerOwner": { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-product-strategy", "stationTitle": "Automatisierungschance & Strategie", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "suggestedAnswerOwner": { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-consumer-experience", "stationTitle": "Prozess-/Nutzeranforderungen", "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "suggestedAnswerOwner": { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "consulted", "responsibilities": [ { "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "role": "suggested-answer-owner" } ] } }, { "stationId": "api-design", "stationTitle": "Automatisierungs-Workflow-Design", "resourceId": "interactionCanvas", "resourceTitle": "Interaction Canvas", "canvasId": "interactionCanvas", "suggestedAnswerOwner": { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [ { "resourceId": "interactionCanvas", "resourceTitle": "Interaction Canvas", "canvasId": "interactionCanvas", "role": "suggested-answer-owner" } ] } } ], "stations": [ { "index": 1, "id": "api-product-strategy", "slug": "method/api-product-strategy", "icon": "strategy-outline", "title": "Automatisierungschance & Strategie", "description": "Identifizieren und priorisieren Sie Automatisierungsmöglichkeiten nach Wert, Machbarkeit, Risiko, Ownership und erwarteter Prozesswirkung.", "whyItMatters": "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden.", "applyInWork": "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "outcomes": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung" ], "steps": [ { "text": "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas" } ], "questions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "criteria": [ "metrics-feedback-available", "business-goals-defined", "market-research-done", "stakeholder-approval" ], "criteriaDetails": [ { "id": "metrics-feedback-available", "title": "Relevante Marktsignale, Feedback oder operative Erkenntnisse liegen vor, um diese Capability-Möglichkeit zu bewerten.", "description": "Relevant market signals, feedback, or operational insights are available to guide this API opportunity." }, { "id": "business-goals-defined", "title": "Die Geschäftsziele sind definiert.", "description": "Business goals are defined." }, { "id": "market-research-done", "title": "Die Marktrecherche identifiziert relevante Capability-Möglichkeiten.", "description": "Market research identifies API opportunities." }, { "id": "stakeholder-approval", "title": "Die relevanten Stakeholder stimmen zu, dass diese Capability-Möglichkeit weiter untersucht und priorisiert werden sollte.", "description": "Relevant stakeholders agree this API opportunity is worth exploring and prioritizing." } ], "baseTitle": "Strategie", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "stakeholders": [ { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "lead", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "evidence": [ "design-artifact", "documentation", "research", "roadmap" ] }, { "index": 2, "id": "api-consumer-experience", "slug": "method/api-consumer-experience", "icon": "deployed-code-account-outline", "title": "Prozess-/Nutzeranforderungen", "description": "Erfassen Sie Prozessnutzer, Rollen, Übergaben, Ausnahmen, Einschränkungen und Serviceerwartungen, bevor die Automatisierung entworfen wird.", "whyItMatters": "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab.", "applyInWork": "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "outcomes": [ "Explizite Nutzeranforderungen und Onboarding-Erwartungen", "Definieren Sie die API-Erlebnisreise", "Onboarding, Dokumentation und Feedback planen", "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)" ], "steps": [ { "text": "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null } ], "questions": [ "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab." ], "criteria": [ "api-opportunity-documented", "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-opportunity-documented", "title": "Die Capability-Möglichkeit wurde identifiziert und dokumentiert.", "description": "Individual API opportunities are identified and documented." }, { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "baseTitle": "Nutzeranforderungen & Onboarding", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "stakeholders": [ { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "consulted", "responsibilities": [ { "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "role": "suggested-answer-owner" } ] } ], "resources": [ { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "evidence": [ "design-artifact", "documentation", "consumer-feedback" ] }, { "index": 3, "id": "api-platform-architecture", "slug": "method/api-platform-architecture", "icon": "code-blocks-outline", "title": "Automatisierungsplattformentscheidung", "description": "Waehlen Sie Automatisierungsplattform, Runtime, Integrationsansatz, Governance-Kontrollen und operative Einschraenkungen.", "whyItMatters": "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen.", "applyInWork": "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "outcomes": [ "Validierte Architektur- und Plattformentscheidung", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit" ], "steps": [ { "text": "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas" }, { "text": "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas" }, { "text": "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas" }, { "text": "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null } ], "questions": [ "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen." ], "criteria": [ "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "baseTitle": "Architektur & Plattformentscheidungen", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "architecture", "stakeholders": [ { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "core", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "consulted", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "automation-operational-ownership-guide", "slug": "resources/automation-operational-ownership-guide", "title": "Leitfaden für die betriebliche Verantwortung von Automatisierungen", "description": "Orientierung zur Definition von Verantwortung, Runbooks, Überwachung, Support, Monitoring, Änderungskontrolle und kontinuierlicher Verbesserung für Automatisierungen.", "category": "guideline", "icon": "edit-document-outline", "order": 185, "outcomes": [ "Klares Betriebsmodell für die Automatisierung", "Verantwortlichkeiten für Eigentum, Support und Eskalation zugewiesen", "Monitoring- und Änderungspraktiken für den Live-Betrieb bereit" ], "steps": [ "Definieren Sie fachliche, technische und betriebliche Verantwortliche für die Automatisierung.", "Dokumentieren Sie Runbooks, Supportwege, Monitoring-Signale, Serviceerwartungen und Eskalationsregeln.", "Legen Sie Änderungskontrolle und Review-Praktiken für Workflow-, Plattform- und Regeländerungen fest." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "architecture-decision", "documentation", "platform-config", "metrics" ] }, { "index": 4, "id": "api-design", "slug": "method/api-design", "icon": "api", "title": "Automatisierungs-Workflow-Design", "description": "Entwerfen Sie Automatisierungsworkflow, Trigger, Entscheidungspunkte, Integrationen, Datenverarbeitung, relevante Schnittstellenvertraege und Ausnahmefaelle.", "whyItMatters": "Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist.", "applyInWork": "Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.", "outcomes": [ "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise", "Wiederverwendbare und validierte Schnittstellenverträge", "Entwürfe, die auf Domänenmodelle und Interaktionsmuster abgestimmt sind", "Rückverfolgbarkeit des Designs zum Geschäftswert" ], "steps": [ { "text": "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "resourceId": "interactionCanvas", "resourceTitle": "Interaction Canvas", "canvasId": "interactionCanvas" }, { "text": "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "restCanvas", "resourceTitle": "REST Canvas", "canvasId": "restCanvas" }, { "text": "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "eventCanvas", "resourceTitle": "Event Canvas", "canvasId": "eventCanvas" }, { "text": "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "graphqlCanvas", "resourceTitle": "GraphQL Canvas", "canvasId": "graphqlCanvas" }, { "text": "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "resourceId": "api-design-principles", "resourceTitle": "API Design Prinzipien", "canvasId": null }, { "text": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "resourceId": "contract-first-design", "resourceTitle": "Vertrag Erstes Design", "canvasId": null }, { "text": "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.", "Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "baseTitle": "Lösungs- & Schnittstellendesign", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "design", "stakeholders": [ { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [ { "resourceId": "interactionCanvas", "resourceTitle": "Interaction Canvas", "canvasId": "interactionCanvas", "role": "suggested-answer-owner" } ] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "process-workflow-design-guide", "slug": "resources/process-workflow-design-guide", "title": "Leitfaden für Prozess- und Workflow-Design", "description": "Orientierung zur Modellierung von Prozessschritten, Rollen, Übergaben, Entscheidungspunkten, Zuständen, Eingaben, Ausgaben und Ausnahmen, die einen Automatisierungs-Workflow prägen.", "category": "guideline", "icon": "edit-document-outline", "order": 181, "outcomes": [ "Klares Design des Automatisierungs-Workflows", "Prozessschritte und Übergaben vor der Implementierung dokumentiert", "Workflow-Zustände, Eingaben, Ausgaben und Ausnahmewege verstanden" ], "steps": [ "Modellieren Sie den aktuellen und den Ziel-Prozessfluss einschließlich menschlicher und systemseitiger Verantwortlichkeiten.", "Identifizieren Sie Workflow-Auslöser, Zustände, Entscheidungen, Dateneingaben, Ausgaben und Abschlusskriterien.", "Dokumentieren Sie Übergaben zwischen Nutzern, Systemen, Betrieb und Supportrollen.", "Bestätigen Sie, welche Schritte automatisiert werden sollen und welche menschliches Urteilsvermögen erfordern." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "decision-business-rules-guide", "slug": "resources/decision-business-rules-guide", "title": "Leitfaden für Entscheidungen und Geschäftsregeln", "description": "Orientierung zur Erfassung von Regeln, Schwellenwerten, Entscheidungen, Genehmigungen, Eignungsprüfungen und Regelverantwortung für das Automatisierungsdesign.", "category": "guideline", "icon": "edit-document-outline", "order": 182, "outcomes": [ "Explizite Entscheidungen und Geschäftsregeln", "Regeln und Schwellenwerte mit Verantwortlichen dokumentiert", "Automatisierungsentscheidungen auf Richtlinien, Prozesse oder Geschäftsabsicht zurückführbar" ], "steps": [ "Listen Sie Entscheidungen auf, die die Automatisierung treffen oder unterstützen muss.", "Dokumentieren Sie Regelbedingungen, Schwellenwerte, Ausnahmen, Genehmigungen und Eskalationspunkte.", "Identifizieren Sie Regelverantwortliche und Änderungsgovernance für jeden Entscheidungsbereich." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-trigger-handoff-exception-guide", "slug": "resources/automation-trigger-handoff-exception-guide", "title": "Leitfaden für Automatisierungsauslöser, Übergaben und Ausnahmen", "description": "Orientierung zur Definition von Automatisierungsauslösern, menschlichen Übergaben, Ausnahmebehandlung, Wiederholungen, Ausgleichsmaßnahmen und Support-Eskalationswegen.", "category": "guideline", "icon": "edit-document-outline", "order": 183, "outcomes": [ "Definierte Automatisierungsauslöser und Ausnahmewege", "Menschliche Übergaben und Support-Eskalationen sind explizit", "Ausnahmen, Wiederholungen und Ausgleichsmaßnahmen sind vor der Bereitstellung entworfen" ], "steps": [ "Definieren Sie Ereignisse, Zeitpläne, Nutzeraktionen oder Systemzustände, die die Automatisierung auslösen.", "Modellieren Sie Übergaben von der Automatisierung an Nutzer, Betreiber oder Supportteams.", "Dokumentieren Sie Ausnahmen, Wiederholungsregeln, Timeout-Verhalten und Rückfallwege.", "Definieren Sie Warnungen und Eskalationsschwellen für fehlgeschlagene oder uneindeutige Automatisierungsergebnisse." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "spec", "contract", "design-artifact", "documentation" ] }, { "index": 5, "id": "api-delivery", "slug": "method/api-delivery", "icon": "code", "title": "Automatisierungsbereitstellung & Betrieb", "description": "Bauen, testen, deployen, dokumentieren und betreiben Sie die Automatisierung mit klarer Ownership, Kontrollen und Rollback-Pfaden.", "whyItMatters": "Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird.", "applyInWork": "Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.", "outcomes": [ "Eine bereitgestellte Capability, die mit dem validierten Schnittstellenvertrag übereinstimmt", "Zuverlässige und automatisierte CI/CD-Pipelines", "Funktionale und nicht-funktionale Tests integriert", "Sichere und gesetzeskonforme Bereitstellungspipelines" ], "steps": [ { "text": "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "resourceId": "api-testing-best-practices", "resourceTitle": "Bewährte Praktiken für API-Tests", "canvasId": null }, { "text": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "resourceId": "api-security-best-practices", "resourceTitle": "Bewährte Praktiken für die API-Sicherheit", "canvasId": null }, { "text": "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.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags 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.", "Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.", "Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "baseTitle": "Bereitstellung & Betrieb", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "delivery", "stakeholders": [ { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "automation-testing-guide", "slug": "resources/automation-testing-guide", "title": "Leitfaden für Automatisierungstests", "description": "Orientierung zum Testen automatisierter Workflows, Entscheidungen, Integrationen, Ausnahmen, Rollback-Verhalten, Überwachung und Nutzerauswirkungen vor der Veröffentlichung.", "category": "guideline", "icon": "edit-document-outline", "order": 184, "outcomes": [ "Validiertes Automatisierungsverhalten", "Workflow-, Regel-, Ausnahme- und Integrationstests definiert", "Veröffentlichungssicherheit für automatisierte und menschlich unterstützte Pfade" ], "steps": [ "Erstellen Sie Tests für Standardabläufe, Grenzfälle, Ausnahmen, Wiederholungen und Übergaben.", "Validieren Sie Geschäftsregeln und Entscheidungsergebnisse mit repräsentativen Daten.", "Testen Sie Rollback, Wiederherstellung, Beobachtbarkeit und manuelle Eingriffspfade.", "Beziehen Sie Nutzer und Betreiber in Abnahmetests ein, wenn die Automatisierung Arbeitsweisen verändert." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-operational-ownership-guide", "slug": "resources/automation-operational-ownership-guide", "title": "Leitfaden für die betriebliche Verantwortung von Automatisierungen", "description": "Orientierung zur Definition von Verantwortung, Runbooks, Überwachung, Support, Monitoring, Änderungskontrolle und kontinuierlicher Verbesserung für Automatisierungen.", "category": "guideline", "icon": "edit-document-outline", "order": 185, "outcomes": [ "Klares Betriebsmodell für die Automatisierung", "Verantwortlichkeiten für Eigentum, Support und Eskalation zugewiesen", "Monitoring- und Änderungspraktiken für den Live-Betrieb bereit" ], "steps": [ "Definieren Sie fachliche, technische und betriebliche Verantwortliche für die Automatisierung.", "Dokumentieren Sie Runbooks, Supportwege, Monitoring-Signale, Serviceerwartungen und Eskalationsregeln.", "Legen Sie Änderungskontrolle und Review-Praktiken für Workflow-, Plattform- und Regeländerungen fest." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-rollback-supervision-guide", "slug": "resources/automation-rollback-supervision-guide", "title": "Leitfaden für Rollback und Überwachung von Automatisierungen", "description": "Orientierung zur Gestaltung von Rollback-, Pausen-, manuellen Übersteuerungs-, Monitoring-, Überwachungs- und Wiederherstellungspfaden für Automatisierungen.", "category": "guideline", "icon": "edit-document-outline", "order": 186, "outcomes": [ "Kontrollierte Wiederherstellungspfade für Automatisierungen", "Rollback-, Pausen- und Übersteuerungsverhalten dokumentiert", "Überwachungsbedarf und Wiederherstellungsverantwortlichkeiten definiert" ], "steps": [ "Identifizieren Sie Aktionen, die rückgängig gemacht, pausiert oder manuell übersteuert werden können müssen.", "Definieren Sie Rollback-, Kompensations- und Wiederherstellungsverfahren für fehlgeschlagene oder falsche Automatisierungsergebnisse.", "Dokumentieren Sie Überwachungsschwellen, Warnungen und manuelle Entscheidungspunkte.", "Validieren Sie Wiederherstellungsverfahren vor der Veröffentlichung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "implementation", "pipeline-config", "test-report", "security-report" ] }, { "index": 6, "id": "api-audit", "slug": "method/api-audit", "icon": "check-box-outline", "title": "Automatisierungsbereitschaftsprüfung", "description": "Prüfen Sie Automatisierungsbereitschaft, Qualität, Risiko, Compliance, menschliche Aufsicht, Nachweise und Freigabekriterien.", "whyItMatters": "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung.", "applyInWork": "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "outcomes": [ "Dokumentierte Bereitschaft für Veröffentlichung und Wiederverwendung", "Klare Dokumentation des API-Designs und der Implementierungsentscheidungen", "Sicherheit, Leistung und Compliance validiert", "Geringeres Risiko von Problemen in der Produktion" ], "steps": [ { "text": "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null }, { "text": "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.", "resourceId": "api-compliance-best-practices", "resourceTitle": "Bewährte Praktiken zur API-Einhaltung", "canvasId": null }, { "text": "Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.", "resourceTitle": "", "canvasId": null } ], "questions": [ "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "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.", "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung." ], "criteria": [ "architecture-patterns-validated", "design-reflects-business-value", "api-description-available", "api-consistency", "api-contract-tested" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-description-available", "title": "Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.", "description": "The API and its exposed capabilities are described clearly enough for review, audit, and onboarding." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." }, { "id": "api-contract-tested", "title": "Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.", "description": "The API contract is tested and meets functional and non-functional requirements." } ], "baseTitle": "Qualitäts- & Bereitschaftssicherung", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "stakeholders": [ { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "automation-readiness-checklist", "slug": "resources/automation-readiness-checklist", "title": "Checkliste zur Automatisierungsbereitschaft", "description": "Eine Checkliste zur Validierung von Automatisierungs-Workflow, Kontrollen, Risiko, Compliance, menschlicher Aufsicht, Testnachweisen, Rollback, Betrieb und Veröffentlichungsbereitschaft.", "category": "checklist", "icon": "check-box-outline", "order": 187, "outcomes": [ "Dokumentierte Automatisierungsbereitschaft", "Bekannte Bereitschaftslücken und Gegenmaßnahmen vor der Veröffentlichung", "Nachweise für Qualität, Risiko, Compliance, Aufsicht und betriebliche Freigabe" ], "steps": [ "Prüfen Sie Workflow-Design, Geschäftsregeln, Kontrollen, Zugriff, Datenverarbeitung und Ausnahmewege.", "Überprüfen Sie Testnachweise, Rollback-Verfahren, Überwachungsmodell und Supportbereitschaft.", "Bestätigen Sie Verantwortung, Runbooks, Monitoring, Änderungskontrollen und Veröffentlichungsfreigabe.", "Dokumentieren Sie ungelöste Lücken, Entscheidungen und akzeptierte Risiken vor der Veröffentlichung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-compliance-best-practices", "slug": "resources/api-compliance-best-practices", "title": "Bewährte Praktiken zur API-Einhaltung", "description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 104, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "audit-report", "compliance-report", "security-report", "test-report" ] }, { "index": 7, "id": "api-publishing", "slug": "method/api-publishing", "icon": "deployed-code-outline", "title": "Automatisierungs-Rollout & Enablement", "description": "Befähigen Sie Nutzer und Betreiber mit Auffindbarkeit, Onboarding, Betriebsanweisungen, Supportpfaden und Änderungs kommunikation.", "whyItMatters": "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen.", "applyInWork": "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "outcomes": [ "Eine auffindbare und nutzbare Capability", "Klare API-Einführungs- und Registrierungsprozesse", "Dokumentation, Sicherheitsmodelle und Richtlinien verfügbar", "APIs bereit für Skalierung und Governance" ], "steps": [ { "text": "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null }, { "text": "Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "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.", "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen." ], "criteria": [ "audit-passed", "audit-reports-shared", "api-ready-for-publishing", "api-documentation-ready" ], "criteriaDetails": [ { "id": "audit-passed", "title": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "description": "The API passes compliance, security, and audit checks." }, { "id": "audit-reports-shared", "title": "Audit-Ergebnisse und Maßnahmenentscheidungen wurden mit den relevanten Stakeholdern geteilt.", "description": "Audit findings and remediation decisions are shared with the relevant stakeholders." }, { "id": "api-ready-for-publishing", "title": "Die Capability ist bereit, über den gewählten Bereitstellungsmechanismus veröffentlicht oder ausgeliefert zu werden.", "description": "The API is ready to be deployed and exposed through the intended gateways and environments." }, { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." } ], "baseTitle": "Veröffentlichung & Enablement", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "stakeholders": [ { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "lead", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "automation-rollout-enablement-guide", "slug": "resources/automation-rollout-enablement-guide", "title": "Leitfaden für Rollout und Enablement von Automatisierungen", "description": "Orientierung für die Einführung von Automatisierungen mit Nutzerkommunikation, Onboarding, Betriebsanweisungen, Supportwegen, Change Management und Feedback-Schleifen.", "category": "guideline", "icon": "edit-document-outline", "order": 188, "outcomes": [ "Befähigte Automatisierungsnutzer und Betreiber", "Rollout-Kommunikation, Onboarding und Supportwege vorbereitet", "Nutzer und Betreiber verstehen, wie sich die Arbeit nach der Veröffentlichung der Automatisierung verändert" ], "steps": [ "Definieren Sie Rollout-Zielgruppen, Zeitplan, Kommunikationskanäle und Schulungsbedarf.", "Veröffentlichen Sie Betriebsanweisungen, Supportwege, Hinweise zur Ausnahmebehandlung und Eskalationskontakte.", "Planen Sie Übergangsunterstützung für Nutzer, Betreiber und Prozessverantwortliche.", "Sammeln Sie Feedback nach dem Rollout und überführen Sie Verbesserungen in den Backlog." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "service-agreement-template", "slug": "resources/service-agreement-template", "title": "Vorlage für eine Dienstleistungsvereinbarung", "description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "category": "guideline", "icon": "edit-document-outline", "order": 172, "outcomes": [ "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "gateway-config", "developer-portal", "documentation", "release-record" ] }, { "index": 8, "id": "monitoring-and-improving", "slug": "method/monitoring-and-improving", "icon": "analytics-outline", "title": "Automatisierungsmonitoring & Verbesserung", "description": "Überwachen Sie Automatisierungsleistung, Ausnahmen, Zuverlässigkeit, Nutzerergebnisse, operative Auswirkungen und Verbesserungsmöglichkeiten.", "whyItMatters": "Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern.", "applyInWork": "Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.", "outcomes": [ "Gemessene Capability-Gesundheit und Wertbeitrag", "Feedback-Schleifen für Entwickler sind vorhanden", "Kontinuierlich ermittelte und behandelte Probleme", "Iteration der API, abgestimmt auf die Bedürfnisse der Nutzer" ], "steps": [ { "text": "Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null }, { "text": "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null }, { "text": "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null } ], "questions": [ "Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.", "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.", "Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.", "Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern." ], "criteria": [ "api-documentation-ready", "consumer-support-ready", "legal-compliance-clear" ], "criteriaDetails": [ { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." }, { "id": "consumer-support-ready", "title": "Onboarding-, Support- und Kommunikationsprozesse für Nutzer sind bereit.", "description": "Registration, support, and communication processes are ready for API consumers." }, { "id": "legal-compliance-clear", "title": "Rechtliche, Datenschutz- und Compliance-Anforderungen für Veröffentlichung oder Release sind definiert und verstanden.", "description": "Legal, privacy, and compliance requirements for publishing are defined and understood." } ], "baseTitle": "Monitoring & Verbesserung", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "improving", "stakeholders": [ { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "core", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] } ], "resources": [ { "id": "automation-operational-ownership-guide", "slug": "resources/automation-operational-ownership-guide", "title": "Leitfaden für die betriebliche Verantwortung von Automatisierungen", "description": "Orientierung zur Definition von Verantwortung, Runbooks, Überwachung, Support, Monitoring, Änderungskontrolle und kontinuierlicher Verbesserung für Automatisierungen.", "category": "guideline", "icon": "edit-document-outline", "order": 185, "outcomes": [ "Klares Betriebsmodell für die Automatisierung", "Verantwortlichkeiten für Eigentum, Support und Eskalation zugewiesen", "Monitoring- und Änderungspraktiken für den Live-Betrieb bereit" ], "steps": [ "Definieren Sie fachliche, technische und betriebliche Verantwortliche für die Automatisierung.", "Dokumentieren Sie Runbooks, Supportwege, Monitoring-Signale, Serviceerwartungen und Eskalationsregeln.", "Legen Sie Änderungskontrolle und Review-Praktiken für Workflow-, Plattform- und Regeländerungen fest." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "evidence": [ "metrics", "consumer-feedback", "incident-report", "roadmap" ] } ] } ], "lines": [ { "id": "business-opportunities-line", "slug": "business-opportunities-line", "title": "Linie Geschäftsmöglichkeiten", "description": "Konzentriert sich auf die Identifizierung, Bewertung und Produktisierung von Geschäftsmöglichkeiten als wiederverwendbare Capabilities.", "icon": "", "color": "#26b309", "order": 1, "stations": [ "monitoring-and-improving", "api-product-strategy", "user-experience", "market-insights", "business-goals", "competitive-analysis", "ecosystem-vision" ] }, { "id": "platform-architecture-line", "slug": "platform-architecture-line", "title": "Linie Plattformarchitektur", "description": "Behandelt Architekturentscheidungen für Plattformen, Integrationen und Schnittstellen.", "icon": "", "color": "#933469", "order": 2, "stations": [ "api-product-strategy", "api-consumer-experience", "api-platform-architecture", "scalable-infrastructure", "legal-and-compliance", "security-and-privacy", "design-standards", "vendor-management" ] }, { "id": "api-design-line", "slug": "api-design-line", "title": "API-Entwurfslinie", "description": "Konzentriert sich auf Entwurfsprinzipien und Best Practices für Schnittstellen und Integrationslösungen.", "icon": "", "color": "#db9b0c", "order": 3, "stations": [ "api-platform-architecture", "api-design", "api-delivery", "api-audit" ] }, { "id": "delivery-line", "slug": "delivery-line", "title": "Bereitstellungslinie", "description": "Behandelt Implementierung, Tests, Automatisierung und Bereitstellungspraktiken.", "icon": "", "color": "#db9b0c", "order": 4, "stations": [ "api-delivery", "contract-design", "development", "ci-cd", "test-automation", "release-management" ] }, { "id": "publishing-and-adoption-line", "slug": "publishing-and-adoption-line", "title": "Linie Veröffentlichung & Enablement", "description": "Konzentriert sich auf die Veröffentlichung von Capabilities sowie deren Auffindbarkeit, Onboarding und Nutzung.", "icon": "", "color": "#17C6E9", "order": 5, "stations": [ "api-audit", "api-publishing", "monitoring-and-improving", "service-agreements", "api-consumer-adoption", "api-promotion", "partner-integration" ] }, { "id": "operating-model-line", "slug": "operating-model-line", "title": "Linie Betriebsmodell", "description": "Behandelt Governance, Verantwortlichkeiten und das Betriebsmodell für Capabilities.", "icon": "", "color": "#1a3987", "order": 6, "stations": [ "api-product-strategy", "api-mindset", "roles-and-responsibilities", "upskilling", "operating-guidelines", "portfolio-management", "budget-and-resource-management" ] } ], "stations": [ { "id": "api-product-strategy", "slug": "method/api-product-strategy", "icon": "strategy-outline", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen.", "whyItMatters": "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden.", "applyInWork": "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "outcomes": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung" ], "steps": [ { "text": "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas" } ], "questions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "criteria": [ "metrics-feedback-available", "business-goals-defined", "market-research-done", "stakeholder-approval" ], "criteriaDetails": [ { "id": "metrics-feedback-available", "title": "Relevante Marktsignale, Feedback oder operative Erkenntnisse liegen vor, um diese Capability-Möglichkeit zu bewerten.", "description": "Relevant market signals, feedback, or operational insights are available to guide this API opportunity." }, { "id": "business-goals-defined", "title": "Die Geschäftsziele sind definiert.", "description": "Business goals are defined." }, { "id": "market-research-done", "title": "Die Marktrecherche identifiziert relevante Capability-Möglichkeiten.", "description": "Market research identifies API opportunities." }, { "id": "stakeholder-approval", "title": "Die relevanten Stakeholder stimmen zu, dass diese Capability-Möglichkeit weiter untersucht und priorisiert werden sollte.", "description": "Relevant stakeholders agree this API opportunity is worth exploring and prioritizing." } ], "stakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas", "role": "suggested-answer-owner" } ] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "lead", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "lead", "responsibilities": [ { "resourceId": "capabilityValuePropositionCanvas", "resourceTitle": "Capability Value Proposition Canvas", "canvasId": "capabilityValuePropositionCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capabilityBusinessModelCanvas", "resourceTitle": "Capability Business Model Canvas", "canvasId": "capabilityBusinessModelCanvas", "role": "suggested-answer-owner" } ] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "lead", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [ { "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas", "role": "suggested-answer-owner" } ] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [ { "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas", "role": "suggested-answer-owner" } ] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "core", "responsibilities": [] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "api-program-owner", "sourceKey": "api-program-owner", "sourceStakeholderId": "api-program-owner", "title": "API-Programmverantwortlicher", "description": "Koordiniert API-Portfolio-Praktiken, organisatorische Ausrichtung und langfristige Entwicklung von API-Capabilities.", "involvement": "consulted", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "consulted", "responsibilities": [] } ], "evidence": [ "design-artifact", "documentation", "research", "roadmap" ] }, { "id": "user-experience", "slug": "method/user-experience", "icon": "user-attributes-outline", "title": "Benutzerfreundlichkeit - Entwerfen Sie APIs mit dem Benutzer im Hinterkopf", "description": "Stellen Sie sicher, dass die APIs mit Blick auf den Endnutzer entwickelt werden und eine nahtlose und intuitive Erfahrung bieten.", "whyItMatters": "APIs sind nicht nur technische Produkte, sondern auch Produkte für die Benutzer. Ein schlechtes Benutzererlebnis kann zu geringer Akzeptanz und Frustration führen. Diese Station hilft Teams bei der Entwicklung von APIs, die benutzerfreundlich sind und die Bedürfnisse der Nutzer erfüllen.", "applyInWork": "Bereitstellung von Richtlinien, Vorlagen und Tools für die Benutzererfahrung beim API-Design. Sicherstellen, dass die Teams nutzerzentrierte Designpraktiken befolgen und Nutzerfeedback in API-Iterationen einbeziehen.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "APIs, die auf die Bedürfnisse der Nutzer abgestimmt sind", "Intuitive und einheitliche Benutzeroberflächen", "Nutzer-Feedback in API-Design integriert", "Verbesserte Nutzerzufriedenheit und Akzeptanz" ], "steps": [ { "text": "Verwendung von User Personas, um die Bedürfnisse und Erwartungen der Endnutzer zu verstehen", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Führen Sie Nutzerforschung durch, um Erkenntnisse darüber zu gewinnen, wie die Nutzer mit den Ökosystemdiensten oder Ihren API nutzenden Anwendungen interagieren.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Dokumentieren Sie die Anforderungen an die Benutzererfahrung, damit sie beim API-Design verwendet werden können, um sicherzustellen, dass sie intuitiv und einfach zu bedienen sind.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" } ], "questions": [ "Verwendung von User Personas, um die Bedürfnisse und Erwartungen der Endnutzer zu verstehen", "Führen Sie Nutzerforschung durch, um Erkenntnisse darüber zu gewinnen, wie die Nutzer mit den Ökosystemdiensten oder Ihren API nutzenden Anwendungen interagieren.", "Dokumentieren Sie die Anforderungen an die Benutzererfahrung, damit sie beim API-Design verwendet werden können, um sicherzustellen, dass sie intuitiv und einfach zu bedienen sind.", "Bereitstellung von Richtlinien, Vorlagen und Tools für die Benutzererfahrung beim API-Design. Sicherstellen, dass die Teams nutzerzentrierte Designpraktiken befolgen und Nutzerfeedback in API-Iterationen einbeziehen.", "APIs sind nicht nur technische Produkte, sondern auch Produkte für die Benutzer. Ein schlechtes Benutzererlebnis kann zu geringer Akzeptanz und Frustration führen. Diese Station hilft Teams bei der Entwicklung von APIs, die benutzerfreundlich sind und die Bedürfnisse der Nutzer erfüllen." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "api-consumer-experience", "slug": "method/api-consumer-experience", "icon": "deployed-code-account-outline", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter.", "whyItMatters": "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab.", "applyInWork": "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "strategy", "outcomes": [ "Explizite Nutzeranforderungen und Onboarding-Erwartungen", "Definieren Sie die API-Erlebnisreise", "Onboarding, Dokumentation und Feedback planen", "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)" ], "steps": [ { "text": "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "resourceId": "apiValuePropositionCanvas", "resourceTitle": "API Value Proposition Canvas", "canvasId": "apiValuePropositionCanvas" }, { "text": "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "resourceId": "customerJourneyCanvas", "resourceTitle": "Customer Journey Canvas", "canvasId": "customerJourneyCanvas" }, { "text": "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null } ], "questions": [ "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab." ], "criteria": [ "api-opportunity-documented", "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-opportunity-documented", "title": "Die Capability-Möglichkeit wurde identifiziert und dokumentiert.", "description": "Individual API opportunities are identified and documented." }, { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "stakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "lead", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "lead", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "lead", "responsibilities": [ { "resourceId": "consumerExperienceRequirementsCanvas", "resourceTitle": "Consumer Experience Requirements Canvas", "canvasId": "consumerExperienceRequirementsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "consulted", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "consulted", "responsibilities": [] } ], "evidence": [ "design-artifact", "documentation", "consumer-feedback" ] }, { "id": "market-insights", "slug": "method/market-insights", "icon": "area-chart-outline", "title": "Markteinblicke - Verstehen Sie die API-Landschaft", "description": "Analysieren Sie Markttrends, APIs von Mitbewerbern und Industriestandards, um eine API-Strategie zu entwickeln.", "whyItMatters": "Das Verständnis der Marktlandschaft hilft Teams, Chancen zu erkennen, Fallstricke zu vermeiden und ihre APIs an Branchenstandards auszurichten. Diese Station bietet Tools zur Analyse von Markttrends und Angeboten von Wettbewerbern.", "applyInWork": "Bereitstellung von Marktforschungstools, Vorlagen für Konkurrenzanalysen und Ressourcen für Industriestandards. Sicherstellen, dass die Teams über Markttrends informiert bleiben und die Erkenntnisse in die API-Strategie einfließen.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Analyse von Markttrends und APIs von Wettbewerbern", "Ermittlung von Industriestandards und bewährten Verfahren", "API-Strategie auf die Bedürfnisse des Marktes abgestimmt", "Fundierte Entscheidungsfindung auf der Grundlage von Marktkenntnissen" ], "steps": [ { "text": "Führen Sie Marktforschung durch, um Trends, Chancen und Bedrohungen in der API-Landschaft zu identifizieren.", "resourceId": "ecosystem-vision-template", "resourceTitle": "Ökosystem Vision Vorlage", "canvasId": null }, { "text": "Analysieren Sie die APIs der Mitbewerber, um deren Stärken, Schwächen und Alleinstellungsmerkmale zu verstehen.", "resourceId": "competitor-analysis-template", "resourceTitle": "Mitbewerber-Analyse Vorlage", "canvasId": null }, { "text": "Ermittlung von Industriestandards und bewährten Verfahren, um sicherzustellen, dass APIs wettbewerbsfähig und konform sind.", "resourceId": "industry-standards-and-best-practices", "resourceTitle": "Industriestandards und bewährte Praktiken", "canvasId": null } ], "questions": [ "Führen Sie Marktforschung durch, um Trends, Chancen und Bedrohungen in der API-Landschaft zu identifizieren.", "Analysieren Sie die APIs der Mitbewerber, um deren Stärken, Schwächen und Alleinstellungsmerkmale zu verstehen.", "Ermittlung von Industriestandards und bewährten Verfahren, um sicherzustellen, dass APIs wettbewerbsfähig und konform sind.", "Bereitstellung von Marktforschungstools, Vorlagen für Konkurrenzanalysen und Ressourcen für Industriestandards. Sicherstellen, dass die Teams über Markttrends informiert bleiben und die Erkenntnisse in die API-Strategie einfließen.", "Das Verständnis der Marktlandschaft hilft Teams, Chancen zu erkennen, Fallstricke zu vermeiden und ihre APIs an Branchenstandards auszurichten. Diese Station bietet Tools zur Analyse von Markttrends und Angeboten von Wettbewerbern." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "api-platform-architecture", "slug": "method/api-platform-architecture", "icon": "code-blocks-outline", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen.", "whyItMatters": "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen.", "applyInWork": "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "architecture", "outcomes": [ "Validierte Architektur- und Plattformentscheidung", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit" ], "steps": [ { "text": "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas" }, { "text": "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas" }, { "text": "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas" }, { "text": "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null } ], "questions": [ "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen." ], "criteria": [ "api-reusability", "hide-backend-discrepancies", "value-prop-validated", "consumer-segments-identified", "api-roadmap-defined" ], "criteriaDetails": [ { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders." }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified." }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established." } ], "stakeholders": [ { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "lead", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" } ] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "lead", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "role": "suggested-answer-owner" } ] }, { "id": "api-architect", "sourceKey": "api-architect", "sourceStakeholderId": "api-architect", "title": "API-Architekt", "description": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "involvement": "core", "responsibilities": [ { "resourceId": "locationsCanvas", "resourceTitle": "Location Canvas", "canvasId": "locationsCanvas", "role": "suggested-answer-owner" }, { "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas", "role": "suggested-answer-owner" } ] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "core", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [ { "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "role": "suggested-answer-owner" } ] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [ { "resourceId": "businessImpactCanvas", "resourceTitle": "Business Impact Canvas", "canvasId": "businessImpactCanvas", "role": "suggested-answer-owner" } ] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "consulted", "responsibilities": [] } ], "evidence": [ "architecture-decision", "documentation", "platform-config", "metrics" ] }, { "id": "business-goals", "slug": "method/business-goals", "icon": "business-center-outline", "title": "Geschäftsziele - APIs an Geschäftszielen ausrichten", "description": "Sicherstellen, dass die APIs mit den Geschäftszielen übereinstimmen und zu den allgemeinen Unternehmenszielen beitragen.", "whyItMatters": "APIs sollten nicht isoliert entwickelt werden; sie müssen Geschäftsziele unterstützen und vorantreiben. Diese Station hilft Teams dabei, ihre APIs an strategischen Zielen auszurichten und sicherzustellen, dass sie einen echten Geschäftswert liefern.", "applyInWork": "Bereitstellung von Frameworks, Vorlagen und Tools für die Geschäftsausrichtung zur Definition des API-Geschäftswerts. Sicherstellen, dass die Teams die APIs regelmäßig überprüfen und mit den sich ändernden Geschäftszielen abstimmen.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "APIs, die auf die Unternehmensziele abgestimmt sind", "Klarer Geschäftswert für jede API definiert", "Akzeptanz und Unterstützung von API-Initiativen durch die Interessengruppen", "APIs tragen zum Unternehmenserfolg bei" ], "steps": [ { "text": "Definieren Sie die Geschäftsziele und wie APIs diese unterstützen können, indem Sie **die Business Model Canvas** verwenden. Wenn Ihr Geschäft darin besteht, APIs bereitzustellen, gehen Sie durch *die API-Produktstrategie-Station* und füllen Sie **die API Business Model Canvas** aus.", "resourceId": "apiBusinessModelCanvas", "resourceTitle": "API Business Model Canvas", "canvasId": "apiBusinessModelCanvas" }, { "text": "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null }, { "text": "Einbindung von Interessengruppen, um die Abstimmung und Unterstützung von API-Initiativen sicherzustellen.", "resourceId": "stakeholder-engagement-best-practices", "resourceTitle": "Bewährte Praktiken zur Einbindung von Stakeholdern", "canvasId": null } ], "questions": [ "Definieren Sie die Geschäftsziele und wie APIs diese unterstützen können, indem Sie **die Business Model Canvas** verwenden. Wenn Ihr Geschäft darin besteht, APIs bereitzustellen, gehen Sie durch *die API-Produktstrategie-Station* und füllen Sie **die API Business Model Canvas** aus.", "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Einbindung von Interessengruppen, um die Abstimmung und Unterstützung von API-Initiativen sicherzustellen.", "Bereitstellung von Frameworks, Vorlagen und Tools für die Geschäftsausrichtung zur Definition des API-Geschäftswerts. Sicherstellen, dass die Teams die APIs regelmäßig überprüfen und mit den sich ändernden Geschäftszielen abstimmen.", "APIs sollten nicht isoliert entwickelt werden; sie müssen Geschäftsziele unterstützen und vorantreiben. Diese Station hilft Teams dabei, ihre APIs an strategischen Zielen auszurichten und sicherzustellen, dass sie einen echten Geschäftswert liefern." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "api-design", "slug": "method/api-design", "icon": "api", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung.", "whyItMatters": "Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist.", "applyInWork": "Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "design", "outcomes": [ "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise", "Wiederverwendbare und validierte Schnittstellenverträge", "Entwürfe, die auf Domänenmodelle und Interaktionsmuster abgestimmt sind", "Rückverfolgbarkeit des Designs zum Geschäftswert" ], "steps": [ { "text": "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "resourceId": "domainCanvas", "resourceTitle": "Domain Canvas", "canvasId": "domainCanvas" }, { "text": "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "resourceId": "interactionCanvas", "resourceTitle": "Interaction Canvas", "canvasId": "interactionCanvas" }, { "text": "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "restCanvas", "resourceTitle": "REST Canvas", "canvasId": "restCanvas" }, { "text": "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "eventCanvas", "resourceTitle": "Event Canvas", "canvasId": "eventCanvas" }, { "text": "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "resourceId": "graphqlCanvas", "resourceTitle": "GraphQL Canvas", "canvasId": "graphqlCanvas" }, { "text": "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "resourceId": "api-design-principles", "resourceTitle": "API Design Prinzipien", "canvasId": null }, { "text": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "resourceId": "contract-first-design", "resourceTitle": "Vertrag Erstes Design", "canvasId": null }, { "text": "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen.", "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den Schnittstellenvertrag vor der Implementierung zu erfassen und zu validieren.", "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Nutzen Sie passende Designressourcen für die gewählte Umsetzungsweise, z. B. REST, GraphQL, Events, Dateien, Datenprodukte oder direkte Integration.", "Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "stakeholders": [ { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "lead", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "lead", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "core", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "consulted", "responsibilities": [] } ], "evidence": [ "spec", "contract", "design-artifact", "documentation" ] }, { "id": "competitive-analysis", "slug": "method/competitive-analysis", "icon": "trophy-outline", "title": "Wettbewerbsanalyse - Vorsprung auf dem API-Markt", "description": "Analysieren Sie die APIs der Wettbewerber, um Stärken, Schwächen und Möglichkeiten zur Differenzierung zu ermitteln.", "whyItMatters": "Das Verständnis der Wettbewerbslandschaft hilft den Teams, Lücken, Möglichkeiten und verbesserungswürdige Bereiche für ihre APIs zu identifizieren. Diese Station bietet Tools zur Analyse von Wettbewerbern und zur Information über die API-Strategie.", "applyInWork": "Bereitstellung von Tools, Vorlagen und Ressourcen zur Wettbewerbsanalyse. Sicherstellen, dass die Teams regelmäßig die Konkurrenz analysieren und die Erkenntnisse in die API-Strategie und das Design einfließen lassen.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Analyse der Stärken und Schwächen von APIs der Wettbewerber", "Möglichkeiten zur Differenzierung identifiziert", "API-Strategie auf der Grundlage von Erkenntnissen über den Wettbewerb", "Gesteigerte Wettbewerbsfähigkeit auf dem API-Markt" ], "steps": [ { "text": "Führen Sie eine Wettbewerbsanalyse durch, um die wichtigsten Wettbewerber, ihre API-Angebote sowie ihre Stärken und Schwächen zu ermitteln.", "resourceId": "competitor-analysis-template", "resourceTitle": "Mitbewerber-Analyse Vorlage", "canvasId": null }, { "text": "Identifizieren Sie Marktlücken, die Ihre APIs auf der Grundlage der Angebote der Wettbewerber füllen können.", "resourceId": "ecosystem-vision-template", "resourceTitle": "Ökosystem Vision Vorlage", "canvasId": null }, { "text": "Entwickeln Sie eine Differenzierungsstrategie, die die einzigartigen Merkmale und Vorteile Ihrer APIs hervorhebt.", "resourceId": "ecosystem-vision-template", "resourceTitle": "Ökosystem Vision Vorlage", "canvasId": null } ], "questions": [ "Führen Sie eine Wettbewerbsanalyse durch, um die wichtigsten Wettbewerber, ihre API-Angebote sowie ihre Stärken und Schwächen zu ermitteln.", "Identifizieren Sie Marktlücken, die Ihre APIs auf der Grundlage der Angebote der Wettbewerber füllen können.", "Entwickeln Sie eine Differenzierungsstrategie, die die einzigartigen Merkmale und Vorteile Ihrer APIs hervorhebt.", "Bereitstellung von Tools, Vorlagen und Ressourcen zur Wettbewerbsanalyse. Sicherstellen, dass die Teams regelmäßig die Konkurrenz analysieren und die Erkenntnisse in die API-Strategie und das Design einfließen lassen.", "Das Verständnis der Wettbewerbslandschaft hilft den Teams, Lücken, Möglichkeiten und verbesserungswürdige Bereiche für ihre APIs zu identifizieren. Diese Station bietet Tools zur Analyse von Wettbewerbern und zur Information über die API-Strategie." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "api-delivery", "slug": "method/api-delivery", "icon": "code", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um.", "whyItMatters": "Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird.", "applyInWork": "Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "delivery", "outcomes": [ "Eine bereitgestellte Capability, die mit dem validierten Schnittstellenvertrag übereinstimmt", "Zuverlässige und automatisierte CI/CD-Pipelines", "Funktionale und nicht-funktionale Tests integriert", "Sichere und gesetzeskonforme Bereitstellungspipelines" ], "steps": [ { "text": "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "resourceId": "api-testing-best-practices", "resourceTitle": "Bewährte Praktiken für API-Tests", "canvasId": null }, { "text": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "resourceId": "api-security-best-practices", "resourceTitle": "Bewährte Praktiken für die API-Sicherheit", "canvasId": null }, { "text": "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.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags 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.", "Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.", "Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird." ], "criteria": [ "architecture-patterns-validated", "hide-backend-discrepancies", "design-reflects-business-value", "api-consistency" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." } ], "stakeholders": [ { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "lead", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "core", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "consulted", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "consulted", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "consulted", "responsibilities": [] } ], "evidence": [ "implementation", "pipeline-config", "test-report", "security-report" ] }, { "id": "ecosystem-vision", "slug": "method/ecosystem-vision", "icon": "globe-book-rounded", "title": "Ökosystem-Vision - Aufbau von APIs für ein florierendes Ökosystem", "description": "Entwickeln Sie eine Vision dafür, wie Ihre APIs in ein größeres Ökosystem passen, das Zusammenarbeit und Innovation ermöglicht.", "whyItMatters": "APIs sind keine eigenständigen Produkte; sie sind Teil eines größeren Ökosystems. Diese Station hilft Teams zu definieren, wie ihre APIs mit anderen Systemen, Plattformen und Diensten interagieren, um ein florierendes Ökosystem zu schaffen, das die Zusammenarbeit und Innovation fördert.", "applyInWork": "Bereitstellung von Rahmenwerken für die Vision des Ökosystems, Strategien für die Einbindung von Partnern und Integrationsrichtlinien. Sicherstellen, dass die Teams APIs mit Blick auf das Ökosystem entwickeln und die Zusammenarbeit zwischen den Partnern fördern.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Klare Vision eines Ökosystems für APIs definiert", "APIs, die Zusammenarbeit und Integration ermöglichen", "Identifizierung und Einbindung von Ökosystempartnern", "APIs tragen zu einem lebendigen Ökosystem bei" ], "steps": [ { "text": "Definieren Sie die Vision des Ökosystems für Ihre APIs, einschließlich der Frage, wie sie mit anderen Systemen und Plattformen interagieren werden.", "resourceId": "ecosystem-vision-template", "resourceTitle": "Ökosystem Vision Vorlage", "canvasId": null }, { "text": "Identifizieren Sie die wichtigsten Ökosystempartner und -akteure, die von dem Ökosystem profitieren oder zu ihm beitragen werden.", "resourceId": "ecosystem-vision-template", "resourceTitle": "Ökosystem Vision Vorlage", "canvasId": null }, { "text": "Entwicklung von APIs, die eine nahtlose Integration und Zusammenarbeit innerhalb des Ökosystems ermöglichen.", "resourceId": "ecosystem-vision-template", "resourceTitle": "Ökosystem Vision Vorlage", "canvasId": null } ], "questions": [ "Definieren Sie die Vision des Ökosystems für Ihre APIs, einschließlich der Frage, wie sie mit anderen Systemen und Plattformen interagieren werden.", "Identifizieren Sie die wichtigsten Ökosystempartner und -akteure, die von dem Ökosystem profitieren oder zu ihm beitragen werden.", "Entwicklung von APIs, die eine nahtlose Integration und Zusammenarbeit innerhalb des Ökosystems ermöglichen.", "Bereitstellung von Rahmenwerken für die Vision des Ökosystems, Strategien für die Einbindung von Partnern und Integrationsrichtlinien. Sicherstellen, dass die Teams APIs mit Blick auf das Ökosystem entwickeln und die Zusammenarbeit zwischen den Partnern fördern.", "APIs sind keine eigenständigen Produkte; sie sind Teil eines größeren Ökosystems. Diese Station hilft Teams zu definieren, wie ihre APIs mit anderen Systemen, Plattformen und Diensten interagieren, um ein florierendes Ökosystem zu schaffen, das die Zusammenarbeit und Innovation fördert." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "api-audit", "slug": "method/api-audit", "icon": "check-box-outline", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung.", "whyItMatters": "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung.", "applyInWork": "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "outcomes": [ "Dokumentierte Bereitschaft für Veröffentlichung und Wiederverwendung", "Klare Dokumentation des API-Designs und der Implementierungsentscheidungen", "Sicherheit, Leistung und Compliance validiert", "Geringeres Risiko von Problemen in der Produktion" ], "steps": [ { "text": "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null }, { "text": "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.", "resourceId": "api-compliance-best-practices", "resourceTitle": "Bewährte Praktiken zur API-Einhaltung", "canvasId": null }, { "text": "Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.", "resourceTitle": "", "canvasId": null } ], "questions": [ "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "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.", "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung." ], "criteria": [ "architecture-patterns-validated", "design-reflects-business-value", "api-description-available", "api-consistency", "api-contract-tested" ], "criteriaDetails": [ { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders." }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs." }, { "id": "api-description-available", "title": "Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.", "description": "The API and its exposed capabilities are described clearly enough for review, audit, and onboarding." }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions." }, { "id": "api-contract-tested", "title": "Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.", "description": "The API contract is tested and meets functional and non-functional requirements." } ], "stakeholders": [ { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "lead", "responsibilities": [] }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "core", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "core", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "consulted", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] } ], "evidence": [ "audit-report", "compliance-report", "security-report", "test-report" ] }, { "id": "scalable-infrastructure", "slug": "method/scalable-infrastructure", "icon": "cloud-done-outline", "title": "Skalierbare Infrastruktur - APIs auf einem soliden Fundament aufbauen", "description": "Stellen Sie sicher, dass Ihre API-Infrastruktur skalierbar ist, um der wachsenden Nachfrage gerecht zu werden und eine hohe Verfügbarkeit zu gewährleisten.", "whyItMatters": "APIs müssen auf einer robusten Infrastruktur aufgebaut werden, die den zunehmenden Datenverkehr bewältigen und eine hohe Verfügbarkeit gewährleisten kann. Diese Station bietet Richtlinien für den Entwurf und die Implementierung einer skalierbaren Infrastruktur, die das Wachstum und die Leistung von APIs unterstützt.", "applyInWork": "Bereitstellung von Richtlinien für das Infrastrukturdesign, Cloud-nativen Mustern und Überwachungstools. Sicherstellen, dass die Teams eine skalierbare Infrastruktur implementieren, die sich an wechselnde Anforderungen anpassen kann und die API-Leistung unterstützt.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Skalierbare und widerstandsfähige API-Infrastruktur", "Hohe Verfügbarkeit und Leistung unter Last", "Eine für künftiges Wachstum ausgelegte Infrastruktur", "Geringere Ausfallzeiten und verbesserte Benutzerfreundlichkeit" ], "steps": [ { "text": "Entwerfen Sie eine skalierbare und robuste API-Infrastruktur unter Verwendung von Cloud-nativen Mustern und Technologien.", "resourceId": "scalable-infrastructure-best-practices", "resourceTitle": "Bewährte Praktiken für eine skalierbare Infrastruktur", "canvasId": null }, { "text": "Implementierung von Lastausgleich, Caching und anderen Techniken, um hohe Verfügbarkeit und Leistung zu gewährleisten. Sammeln von Infrastrukturanforderungen von API-Teams mithilfe von Capacity Canvas", "resourceId": "capacityCanvas", "resourceTitle": "Capacity Canvas", "canvasId": "capacityCanvas" }, { "text": "Überwachen Sie die Leistung und Kapazität der Infrastruktur, um sicherzustellen, dass sie die wachsende Nachfrage bewältigen kann.", "resourceId": "scalable-infrastructure-best-practices", "resourceTitle": "Bewährte Praktiken für eine skalierbare Infrastruktur", "canvasId": null } ], "questions": [ "Entwerfen Sie eine skalierbare und robuste API-Infrastruktur unter Verwendung von Cloud-nativen Mustern und Technologien.", "Implementierung von Lastausgleich, Caching und anderen Techniken, um hohe Verfügbarkeit und Leistung zu gewährleisten. Sammeln von Infrastrukturanforderungen von API-Teams mithilfe von Capacity Canvas", "Überwachen Sie die Leistung und Kapazität der Infrastruktur, um sicherzustellen, dass sie die wachsende Nachfrage bewältigen kann.", "Bereitstellung von Richtlinien für das Infrastrukturdesign, Cloud-nativen Mustern und Überwachungstools. Sicherstellen, dass die Teams eine skalierbare Infrastruktur implementieren, die sich an wechselnde Anforderungen anpassen kann und die API-Leistung unterstützt.", "APIs müssen auf einer robusten Infrastruktur aufgebaut werden, die den zunehmenden Datenverkehr bewältigen und eine hohe Verfügbarkeit gewährleisten kann. Diese Station bietet Richtlinien für den Entwurf und die Implementierung einer skalierbaren Infrastruktur, die das Wachstum und die Leistung von APIs unterstützt." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "api-publishing", "slug": "method/api-publishing", "icon": "deployed-code-outline", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können.", "whyItMatters": "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen.", "applyInWork": "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "publishing", "outcomes": [ "Eine auffindbare und nutzbare Capability", "Klare API-Einführungs- und Registrierungsprozesse", "Dokumentation, Sicherheitsmodelle und Richtlinien verfügbar", "APIs bereit für Skalierung und Governance" ], "steps": [ { "text": "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null }, { "text": "Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "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.", "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen." ], "criteria": [ "audit-passed", "audit-reports-shared", "api-ready-for-publishing", "api-documentation-ready" ], "criteriaDetails": [ { "id": "audit-passed", "title": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "description": "The API passes compliance, security, and audit checks." }, { "id": "audit-reports-shared", "title": "Audit-Ergebnisse und Maßnahmenentscheidungen wurden mit den relevanten Stakeholdern geteilt.", "description": "Audit findings and remediation decisions are shared with the relevant stakeholders." }, { "id": "api-ready-for-publishing", "title": "Die Capability ist bereit, über den gewählten Bereitstellungsmechanismus veröffentlicht oder ausgeliefert zu werden.", "description": "The API is ready to be deployed and exposed through the intended gateways and environments." }, { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." } ], "stakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "lead", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "lead", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "core", "responsibilities": [] }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "core", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "consulted", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "consulted", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "consulted", "responsibilities": [] } ], "evidence": [ "gateway-config", "developer-portal", "documentation", "release-record" ] }, { "id": "legal-and-compliance", "slug": "method/legal-and-compliance", "icon": "gavel-rounded", "title": "Rechtliche Aspekte und Einhaltung von Vorschriften - Sicherstellen, dass APIs den regulatorischen Standards entsprechen", "description": "Stellen Sie sicher, dass APIs den gesetzlichen und behördlichen Anforderungen entsprechen, um Ihr Unternehmen und Ihre Benutzer zu schützen.", "whyItMatters": "APIs müssen gesetzliche und regulatorische Standards einhalten, um Ihr Unternehmen und Ihre Benutzer zu schützen. Diese Station bietet Tools und Richtlinien, die sicherstellen, dass APIs die Compliance-Anforderungen erfüllen, rechtliche Risiken verringern und den Datenschutz gewährleisten.", "applyInWork": "Bereitstellung von rechtlichen und Compliance-Rahmenwerken, Checklisten und Tools zur Gewährleistung der API-Compliance. Sicherstellen, dass die Teams die rechtlichen Anforderungen beim Entwurf, der Entwicklung und der Veröffentlichung von APIs verstehen und umsetzen.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "APIs, die mit gesetzlichen und regulatorischen Standards übereinstimmen", "Anforderungen an Datenschutz und Privatsphäre erfüllt", "Ermittelte und abgemilderte rechtliche Risiken", "Klare Dokumentation der Compliance-Maßnahmen" ], "steps": [ { "text": "Identifizieren Sie rechtliche und regulatorische Anforderungen, die für Ihre APIs gelten, wie z. B. Datenschutz, Privatsphäre und Sicherheitsstandards.", "resourceId": "api-compliance-best-practices", "resourceTitle": "Bewährte Praktiken zur API-Einhaltung", "canvasId": null }, { "text": "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "resourceId": "api-compliance-best-practices", "resourceTitle": "Bewährte Praktiken zur API-Einhaltung", "canvasId": null }, { "text": "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Nutzern mitgeteilt werden.", "resourceId": "api-compliance-best-practices", "resourceTitle": "Bewährte Praktiken zur API-Einhaltung", "canvasId": null } ], "questions": [ "Identifizieren Sie rechtliche und regulatorische Anforderungen, die für Ihre APIs gelten, wie z. B. Datenschutz, Privatsphäre und Sicherheitsstandards.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Nutzern mitgeteilt werden.", "Bereitstellung von rechtlichen und Compliance-Rahmenwerken, Checklisten und Tools zur Gewährleistung der API-Compliance. Sicherstellen, dass die Teams die rechtlichen Anforderungen beim Entwurf, der Entwicklung und der Veröffentlichung von APIs verstehen und umsetzen.", "APIs müssen gesetzliche und regulatorische Standards einhalten, um Ihr Unternehmen und Ihre Benutzer zu schützen. Diese Station bietet Tools und Richtlinien, die sicherstellen, dass APIs die Compliance-Anforderungen erfüllen, rechtliche Risiken verringern und den Datenschutz gewährleisten." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "monitoring-and-improving", "slug": "method/monitoring-and-improving", "icon": "analytics-outline", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung.", "whyItMatters": "Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern.", "applyInWork": "Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.", "group": "Kernstationen des Capability-Lebenszyklus", "lifecycleStage": "improving", "outcomes": [ "Gemessene Capability-Gesundheit und Wertbeitrag", "Feedback-Schleifen für Entwickler sind vorhanden", "Kontinuierlich ermittelte und behandelte Probleme", "Iteration der API, abgestimmt auf die Bedürfnisse der Nutzer" ], "steps": [ { "text": "Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null }, { "text": "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null }, { "text": "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null } ], "questions": [ "Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.", "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.", "Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.", "Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern." ], "criteria": [ "api-documentation-ready", "consumer-support-ready", "legal-compliance-clear" ], "criteriaDetails": [ { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding." }, { "id": "consumer-support-ready", "title": "Onboarding-, Support- und Kommunikationsprozesse für Nutzer sind bereit.", "description": "Registration, support, and communication processes are ready for API consumers." }, { "id": "legal-compliance-clear", "title": "Rechtliche, Datenschutz- und Compliance-Anforderungen für Veröffentlichung oder Release sind definiert und verstanden.", "description": "Legal, privacy, and compliance requirements for publishing are defined and understood." } ], "stakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "lead", "responsibilities": [] }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "lead", "responsibilities": [] }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "lead", "responsibilities": [] }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "core", "responsibilities": [] }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "core", "responsibilities": [] }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "core", "responsibilities": [] }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "core", "responsibilities": [] }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "core", "responsibilities": [] }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "core", "responsibilities": [] }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "core", "responsibilities": [] }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "core", "responsibilities": [] }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "consulted", "responsibilities": [] }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "consulted", "responsibilities": [] }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "consulted", "responsibilities": [] }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "consulted", "responsibilities": [] } ], "evidence": [ "metrics", "consumer-feedback", "incident-report", "roadmap" ] }, { "id": "security-and-privacy", "slug": "method/security-and-privacy", "icon": "cloud-lock-outline", "title": "Sicherheit und Datenschutz - Schützen Sie Ihre APIs und Benutzer", "description": "Implementierung von Sicherheits- und Datenschutzmaßnahmen zum Schutz von APIs und Nutzerdaten vor Bedrohungen und Verstößen.", "whyItMatters": "APIs sind anfällig für Sicherheitsbedrohungen und Datenschutzverletzungen. Diese Station bietet Richtlinien für die Implementierung von Sicherheits- und Datenschutzmaßnahmen, die APIs und Nutzerdaten schützen und Vertrauen und Compliance gewährleisten.", "applyInWork": "Bereitstellung von Sicherheits-Frameworks, Tools und Best Practices für API-Sicherheit und Datenschutz. Sicherstellen, dass die Teams Sicherheitsmaßnahmen während des gesamten API-Lebenszyklus implementieren, vom Entwurf bis zur Veröffentlichung und Überwachung.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Gegen Bedrohungen und Schwachstellen gesicherte APIs", "Schutz der Nutzerdaten durch Maßnahmen zum Schutz der Privatsphäre", "Bewährte Sicherheitspraktiken bei der Gestaltung und Entwicklung von APIs", "Einhaltung von Sicherheitsstandards und -vorschriften" ], "steps": [ { "text": "Implementieren Sie Sicherheitsmaßnahmen wie Authentifizierung, Autorisierung, Verschlüsselung und Ratenbegrenzung, um APIs vor Bedrohungen zu schützen.", "resourceId": "api-security-best-practices", "resourceTitle": "Bewährte Praktiken für die API-Sicherheit", "canvasId": null }, { "text": "Gewährleistung des Datenschutzes für die Nutzer durch die Umsetzung von Datenschutzmaßnahmen wie Anonymisierung und Zugangskontrolle.", "resourceId": "data-privacy-guidelines", "resourceTitle": "Leitlinien zum Datenschutz", "canvasId": null }, { "text": "Durchführung regelmäßiger Sicherheitsaudits und Schwachstellenbewertungen zur Ermittlung und Minderung von Risiken.", "resourceId": "", "resourceTitle": "", "canvasId": null } ], "questions": [ "Implementieren Sie Sicherheitsmaßnahmen wie Authentifizierung, Autorisierung, Verschlüsselung und Ratenbegrenzung, um APIs vor Bedrohungen zu schützen.", "Gewährleistung des Datenschutzes für die Nutzer durch die Umsetzung von Datenschutzmaßnahmen wie Anonymisierung und Zugangskontrolle.", "Durchführung regelmäßiger Sicherheitsaudits und Schwachstellenbewertungen zur Ermittlung und Minderung von Risiken.", "Bereitstellung von Sicherheits-Frameworks, Tools und Best Practices für API-Sicherheit und Datenschutz. Sicherstellen, dass die Teams Sicherheitsmaßnahmen während des gesamten API-Lebenszyklus implementieren, vom Entwurf bis zur Veröffentlichung und Überwachung.", "APIs sind anfällig für Sicherheitsbedrohungen und Datenschutzverletzungen. Diese Station bietet Richtlinien für die Implementierung von Sicherheits- und Datenschutzmaßnahmen, die APIs und Nutzerdaten schützen und Vertrauen und Compliance gewährleisten." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "design-standards", "slug": "method/design-standards", "icon": "design-services-outline", "title": "Designstandards - Sicherstellung eines konsistenten und qualitativ hochwertigen API-Designs", "description": "Festlegung von Designstandards und -richtlinien, um ein einheitliches und hochwertiges API-Design im gesamten Unternehmen zu gewährleisten.", "whyItMatters": "Ein konsistentes und qualitativ hochwertiges API-Design ist für die Benutzerfreundlichkeit, Wartbarkeit und Skalierbarkeit unerlässlich. Diese Station bietet Designstandards und Richtlinien, die Teams bei der Erstellung von APIs helfen, die einfach zu verwenden, zu verstehen und zu warten sind.", "applyInWork": "Bereitstellung von Dokumentationen zu Designstandards, wiederverwendbaren Komponenten und Designüberprüfungsprozessen. Sicherstellen, dass die Teams die Designstandards befolgen und regelmäßige Überprüfungen durchführen, um ein qualitativ hochwertiges API-Design zu gewährleisten.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Einheitliches API-Design in der gesamten Organisation", "Hochwertige APIs, die den Bedürfnissen der Nutzer entsprechen", "Wiederverwendbare Entwurfsmuster und Komponenten", "Verringerung von Designinkonsistenzen und technischen Schulden" ], "steps": [ { "text": "Definition von Designstandards und Richtlinien für das API-Design, einschließlich Benennungskonventionen, Antwortformaten und Fehlerbehandlung.", "resourceId": "api-design-principles", "resourceTitle": "API Design Prinzipien", "canvasId": null }, { "text": "Erstellen Sie wiederverwendbare Entwurfsmuster und Komponenten, die von Teams genutzt werden können, um Konsistenz und Qualität zu gewährleisten.", "resourceId": "", "resourceTitle": "", "canvasId": null }, { "text": "Durchführung von Entwurfsprüfungen und Audits, um die Einhaltung von Entwurfsstandards zu gewährleisten und verbesserungswürdige Bereiche zu ermitteln.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Definition von Designstandards und Richtlinien für das API-Design, einschließlich Benennungskonventionen, Antwortformaten und Fehlerbehandlung.", "Erstellen Sie wiederverwendbare Entwurfsmuster und Komponenten, die von Teams genutzt werden können, um Konsistenz und Qualität zu gewährleisten.", "Durchführung von Entwurfsprüfungen und Audits, um die Einhaltung von Entwurfsstandards zu gewährleisten und verbesserungswürdige Bereiche zu ermitteln.", "Bereitstellung von Dokumentationen zu Designstandards, wiederverwendbaren Komponenten und Designüberprüfungsprozessen. Sicherstellen, dass die Teams die Designstandards befolgen und regelmäßige Überprüfungen durchführen, um ein qualitativ hochwertiges API-Design zu gewährleisten.", "Ein konsistentes und qualitativ hochwertiges API-Design ist für die Benutzerfreundlichkeit, Wartbarkeit und Skalierbarkeit unerlässlich. Diese Station bietet Designstandards und Richtlinien, die Teams bei der Erstellung von APIs helfen, die einfach zu verwenden, zu verstehen und zu warten sind." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "vendor-management", "slug": "method/vendor-management", "icon": "handshake-outline", "title": "Vendor Management - Verwalten von API-Integrationen von Drittanbietern", "description": "Effiziente Verwaltung von Drittanbieter-APIs und Integrationen zur Gewährleistung von Zuverlässigkeit und Compliance.", "whyItMatters": "APIs von Drittanbietern können Risiken und Abhängigkeiten mit sich bringen, die sich auf Ihr API-Ökosystem auswirken. Diese Station enthält Richtlinien für die Verwaltung von Anbieterbeziehungen, die Zuverlässigkeit, Compliance und Übereinstimmung mit Ihrer API-Strategie sicherstellen.", "applyInWork": "Bereitstellung von Rahmenwerken für die Anbieterverwaltung, Bewertungskriterien und Überwachungsinstrumenten. Sicherstellen, dass die Teams API-Anbieter von Drittanbietern effektiv verwalten, um Zuverlässigkeit, Compliance und Übereinstimmung mit den Unternehmensstandards zu gewährleisten.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Effektive Prozesse für das Lieferantenmanagement eingeführt", "Zuverlässig und sicher integrierte APIs von Drittanbietern", "Einhaltung der Organisationsstandards durch den Lieferanten", "Geringere Risiken im Zusammenhang mit Abhängigkeiten von Dritten" ], "steps": [ { "text": "Einführung von Prozessen für das Anbietermanagement, um Drittanbieter von APIs zu bewerten, einzubinden und zu überwachen.", "resourceId": "vendor-management-best-practices", "resourceTitle": "Bewährte Praktiken im Lieferantenmanagement", "canvasId": null }, { "text": "Definieren Sie Kriterien für die Bewertung von Anbieter-APIs, einschließlich Zuverlässigkeit, Sicherheit und Compliance.", "resourceId": "vendor-management-best-practices", "resourceTitle": "Bewährte Praktiken im Lieferantenmanagement", "canvasId": null }, { "text": "Überwachung der Leistung von Anbietern und der Einhaltung von Service Level Agreements (SLAs) und Organisationsstandards.", "resourceId": "vendor-management-best-practices", "resourceTitle": "Bewährte Praktiken im Lieferantenmanagement", "canvasId": null } ], "questions": [ "Einführung von Prozessen für das Anbietermanagement, um Drittanbieter von APIs zu bewerten, einzubinden und zu überwachen.", "Definieren Sie Kriterien für die Bewertung von Anbieter-APIs, einschließlich Zuverlässigkeit, Sicherheit und Compliance.", "Überwachung der Leistung von Anbietern und der Einhaltung von Service Level Agreements (SLAs) und Organisationsstandards.", "Bereitstellung von Rahmenwerken für die Anbieterverwaltung, Bewertungskriterien und Überwachungsinstrumenten. Sicherstellen, dass die Teams API-Anbieter von Drittanbietern effektiv verwalten, um Zuverlässigkeit, Compliance und Übereinstimmung mit den Unternehmensstandards zu gewährleisten.", "APIs von Drittanbietern können Risiken und Abhängigkeiten mit sich bringen, die sich auf Ihr API-Ökosystem auswirken. Diese Station enthält Richtlinien für die Verwaltung von Anbieterbeziehungen, die Zuverlässigkeit, Compliance und Übereinstimmung mit Ihrer API-Strategie sicherstellen." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "contract-design", "slug": "method/contract-design", "icon": "folder-code-outline", "title": "Vertragsgestaltung - Definieren Sie klare Schnittstellenverträge", "description": "Erstellen Sie klare und genau definierte Schnittstellenverträge, die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien umreißen.", "whyItMatters": "Schnittstellenverträge sind wichtig, um Klarheit und Übereinstimmung zwischen API-Anbietern und Kunden zu gewährleisten. Diese Station bietet Richtlinien für die Gestaltung von Schnittstellenverträgen, die klar, umfassend und leicht verständlich sind.", "applyInWork": "Bereitstellung von Vertragsentwurfsvorlagen, standardisierten Formaten und Überprüfungsprozessen. Sicherstellen, dass Teams klare und gut definierte Schnittstellenverträge erstellen, die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien umreißen.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Klare Schnittstellenverträge für jede API definiert", "Umriss der Erwartungen und Verantwortlichkeiten von API-Anbietern und Nutzern", "Dokumentierte Verwendungsrichtlinien und bewährte Verfahren", "Weniger Missverständnisse und Streitigkeiten über die API-Nutzung" ], "steps": [ { "text": "Definieren Sie Schnittstellenverträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "resourceId": "contract-first-design", "resourceTitle": "Vertrag Erstes Design", "canvasId": null }, { "text": "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare Schnittstellenverträge zu erstellen, die sich leicht austauschen und validieren lassen.", "resourceId": "contract-first-design", "resourceTitle": "Vertrag Erstes Design", "canvasId": null }, { "text": "Sicherstellen, dass die Schnittstellenverträge von den Beteiligten geprüft und genehmigt werden, um Übereinstimmung und Klarheit zu gewährleisten.", "resourceId": "api-audit-checklist", "resourceTitle": "API Audit Checkliste", "canvasId": null } ], "questions": [ "Definieren Sie Schnittstellenverträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare Schnittstellenverträge zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Schnittstellenverträge von den Beteiligten geprüft und genehmigt werden, um Übereinstimmung und Klarheit zu gewährleisten.", "Bereitstellung von Vertragsentwurfsvorlagen, standardisierten Formaten und Überprüfungsprozessen. Sicherstellen, dass Teams klare und gut definierte Schnittstellenverträge erstellen, die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien umreißen.", "Schnittstellenverträge sind wichtig, um Klarheit und Übereinstimmung zwischen API-Anbietern und Kunden zu gewährleisten. Diese Station bietet Richtlinien für die Gestaltung von Schnittstellenverträgen, die klar, umfassend und leicht verständlich sind." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "development", "slug": "method/development", "icon": "deployed-code-outline", "title": "Entwicklung - Erstellen von APIs mit bewährten Praktiken", "description": "Implementierung von APIs unter Verwendung von Best Practices und Frameworks zur Gewährleistung von Qualität, Wartbarkeit und Skalierbarkeit.", "whyItMatters": "Die API-Entwicklung ist eine entscheidende Phase, die die Qualität und Zuverlässigkeit der API bestimmt. Diese Station bietet Best Practices und Frameworks für die API-Entwicklung, die sicherstellen, dass APIs nach hohen Standards erstellt werden und effektiv gewartet und skaliert werden können.", "applyInWork": "Bereitstellung von Entwicklungsrahmen, Bibliotheken und Codierungsstandards für die API-Implementierung. Sicherstellen, dass die Teams Best Practices befolgen und Code-Reviews durchführen, um eine hochwertige API-Entwicklung zu gewährleisten.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "APIs, die unter Verwendung bewährter Verfahren und Rahmenwerke entwickelt werden", "Hochwertige, wartbare und skalierbare APIs", "Befolgung einheitlicher Kodierungsstandards und -praktiken", "Geringere Entwicklungszeit und weniger technische Schulden" ], "steps": [ { "text": "Verwendung etablierter Frameworks und Bibliotheken zur Implementierung von APIs, um sicherzustellen, dass sie wiederverwendbar und wartbar sind.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null }, { "text": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass Schnittstellenverträge vor der Implementierung validiert werden.", "resourceId": "contract-first-design", "resourceTitle": "Vertrag Erstes Design", "canvasId": null }, { "text": "Befolgen Sie Kodierungsstandards und bewährte Verfahren, um eine konsistente und hochwertige API-Entwicklung zu gewährleisten.", "resourceId": "api-development-best-practices", "resourceTitle": "Bewährte Praktiken der API-Entwicklung", "canvasId": null } ], "questions": [ "Verwendung etablierter Frameworks und Bibliotheken zur Implementierung von APIs, um sicherzustellen, dass sie wiederverwendbar und wartbar sind.", "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass Schnittstellenverträge vor der Implementierung validiert werden.", "Befolgen Sie Kodierungsstandards und bewährte Verfahren, um eine konsistente und hochwertige API-Entwicklung zu gewährleisten.", "Bereitstellung von Entwicklungsrahmen, Bibliotheken und Codierungsstandards für die API-Implementierung. Sicherstellen, dass die Teams Best Practices befolgen und Code-Reviews durchführen, um eine hochwertige API-Entwicklung zu gewährleisten.", "Die API-Entwicklung ist eine entscheidende Phase, die die Qualität und Zuverlässigkeit der API bestimmt. Diese Station bietet Best Practices und Frameworks für die API-Entwicklung, die sicherstellen, dass APIs nach hohen Standards erstellt werden und effektiv gewartet und skaliert werden können." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "ci-cd", "slug": "method/ci-cd", "icon": "deployed-code-update-outline", "title": "CI/CD - Automatisierte API-Bereitstellung", "description": "Implementieren Sie Pipelines für kontinuierliche Integration und kontinuierliche Bereitstellung (CI/CD), um die API-Bereitstellung zu automatisieren und eine gleichbleibende Qualität zu gewährleisten.", "whyItMatters": "CI/CD ist wichtig, um sicherzustellen, dass APIs schnell, zuverlässig und in hoher Qualität bereitgestellt werden. Diese Station bietet Richtlinien für die Implementierung von CI/CD-Pipelines, die die Build-, Test- und Bereitstellungsprozesse für APIs automatisieren.", "applyInWork": "Bereitstellung von CI/CD-Frameworks, Tools und Best Practices für die API-Bereitstellung. Sicherstellen, dass Teams automatisierte Pipelines implementieren, die die kontinuierliche Integration, Prüfung und Bereitstellung von APIs unterstützen.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Automatisierte CI/CD-Pipelines für die API-Bereitstellung eingerichtet", "Konsistente Qualität und Rückverfolgbarkeit bei der API-Lieferung", "Schnellere Iterationen und kürzere Markteinführungszeiten", "Verbesserte Zusammenarbeit und Feedback-Schleifen bei der API-Entwicklung" ], "steps": [ { "text": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "resourceId": "api-testing-best-practices", "resourceTitle": "Bewährte Praktiken für API-Tests", "canvasId": null }, { "text": "Implementieren Sie automatisierte Sicherheitsprüfungen und Compliance-Validierungen in der CI/CD-Pipeline, um sicherzustellen, dass APIs sicher und konform sind.", "resourceId": "api-security-best-practices", "resourceTitle": "Bewährte Praktiken für die API-Sicherheit", "canvasId": null } ], "questions": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Implementieren Sie automatisierte Sicherheitsprüfungen und Compliance-Validierungen in der CI/CD-Pipeline, um sicherzustellen, dass APIs sicher und konform sind.", "Bereitstellung von CI/CD-Frameworks, Tools und Best Practices für die API-Bereitstellung. Sicherstellen, dass Teams automatisierte Pipelines implementieren, die die kontinuierliche Integration, Prüfung und Bereitstellung von APIs unterstützen.", "CI/CD ist wichtig, um sicherzustellen, dass APIs schnell, zuverlässig und in hoher Qualität bereitgestellt werden. Diese Station bietet Richtlinien für die Implementierung von CI/CD-Pipelines, die die Build-, Test- und Bereitstellungsprozesse für APIs automatisieren." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "test-automation", "slug": "method/test-automation", "icon": "deployed-code-alert-outline", "title": "Testautomatisierung - Sicherung der API-Qualität", "description": "Implementieren Sie automatisierte Testverfahren, um die Qualität, Zuverlässigkeit und Leistung von APIs sicherzustellen.", "whyItMatters": "Automatisierte Tests sind entscheidend, um sicherzustellen, dass APIs korrekt funktionieren und den Qualitätsstandards entsprechen. Diese Station bietet Richtlinien für die Implementierung automatisierter Testverfahren, die funktionale, Sicherheits- und Leistungstests für APIs umfassen.", "applyInWork": "Bereitstellung von Testautomatisierungs-Frameworks, Tools und Best Practices für API-Tests. Sicherstellen, dass Teams automatisierte Tests implementieren, die funktionale, Sicherheits- und Leistungsaspekte von APIs abdecken.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Automatisierte Testverfahren für APIs implementiert", "Automatisierte Funktions-, Sicherheits- und Leistungstests", "Reduzierter manueller Testaufwand und erhöhte Testabdeckung", "Verbesserte Zuverlässigkeit und Qualität der API" ], "steps": [ { "text": "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren.", "resourceId": "api-testing-best-practices", "resourceTitle": "Bewährte Praktiken für API-Tests", "canvasId": null }, { "text": "Implementierung von Testautomatisierungs-Frameworks, die Vertragstests, Integrationstests und End-to-End-Tests unterstützen.", "resourceId": "api-testing-best-practices", "resourceTitle": "Bewährte Praktiken für API-Tests", "canvasId": null }, { "text": "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null } ], "questions": [ "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren.", "Implementierung von Testautomatisierungs-Frameworks, die Vertragstests, Integrationstests und End-to-End-Tests unterstützen.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Bereitstellung von Testautomatisierungs-Frameworks, Tools und Best Practices für API-Tests. Sicherstellen, dass Teams automatisierte Tests implementieren, die funktionale, Sicherheits- und Leistungsaspekte von APIs abdecken.", "Automatisierte Tests sind entscheidend, um sicherzustellen, dass APIs korrekt funktionieren und den Qualitätsstandards entsprechen. Diese Station bietet Richtlinien für die Implementierung automatisierter Testverfahren, die funktionale, Sicherheits- und Leistungstests für APIs umfassen." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "release-management", "slug": "method/release-management", "icon": "rocket-launch-outline", "title": "Release Management - Effektive Verwaltung von API-Releases", "description": "Implementierung von Release-Management-Verfahren zur Gewährleistung reibungsloser und kontrollierter API-Releases.", "whyItMatters": "Ein effektives Versionsmanagement ist unerlässlich, um sicherzustellen, dass API-Versionen reibungslos, kontrolliert und auf die Geschäftsanforderungen abgestimmt sind. Diese Station bietet Richtlinien für die Verwaltung von API-Releases, einschließlich Versionierung, Bereitstellungsstrategien und Rollback-Verfahren.", "applyInWork": "Bereitstellung von Rahmenwerken für die Versionsverwaltung, Richtlinien für die Versionierung und Strategien für die Bereitstellung. Sicherstellen, dass die Teams Best Practices für die Verwaltung von API-Releases befolgen, einschließlich Versionierung, Bereitstellung und Rollback-Verfahren.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Kontrollierte und reibungslose API-Freigaben", "Festlegung von Versions- und Bereitstellungsstrategien", "Rollback-Verfahren für API-Releases eingeführt", "Geringere Risiken im Zusammenhang mit API-Änderungen" ], "steps": [ { "text": "Definieren Sie Versionsstrategien für APIs, um Änderungen zu verwalten und Abwärtskompatibilität zu gewährleisten.", "resourceId": "api-versioning-best-practices", "resourceTitle": "Bewährte Praktiken der API-Versionierung", "canvasId": null }, { "text": "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "resourceId": "apiops-CI-CD-for-apis", "resourceTitle": "APIOps CI/CD für APIs", "canvasId": null }, { "text": "Einführung von Rollback-Verfahren zur schnellen Rückgängigmachung von Änderungen im Falle von Problemen bei API-Releases.", "resourceId": "", "resourceTitle": "", "canvasId": null } ], "questions": [ "Definieren Sie Versionsstrategien für APIs, um Änderungen zu verwalten und Abwärtskompatibilität zu gewährleisten.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Einführung von Rollback-Verfahren zur schnellen Rückgängigmachung von Änderungen im Falle von Problemen bei API-Releases.", "Bereitstellung von Rahmenwerken für die Versionsverwaltung, Richtlinien für die Versionierung und Strategien für die Bereitstellung. Sicherstellen, dass die Teams Best Practices für die Verwaltung von API-Releases befolgen, einschließlich Versionierung, Bereitstellung und Rollback-Verfahren.", "Ein effektives Versionsmanagement ist unerlässlich, um sicherzustellen, dass API-Versionen reibungslos, kontrolliert und auf die Geschäftsanforderungen abgestimmt sind. Diese Station bietet Richtlinien für die Verwaltung von API-Releases, einschließlich Versionierung, Bereitstellungsstrategien und Rollback-Verfahren." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "service-agreements", "slug": "method/service-agreements", "icon": "contract-outline", "title": "Servicevereinbarungen - Definieren Sie API-Service-Levels", "description": "Erstellen Sie Dienstleistungsvereinbarungen, in denen die Erwartungen, das Leistungsniveau und die Zuständigkeiten von API-Anbietern und Kunden festgelegt sind.", "whyItMatters": "Dienstleistungsvereinbarungen sind wichtig, um Klarheit und Übereinstimmung zwischen API-Anbietern und Kunden zu gewährleisten. Diese Station bietet Richtlinien für die Erstellung von Servicevereinbarungen, die Erwartungen, Servicelevel und Verantwortlichkeiten umreißen und so Missverständnisse und Streitigkeiten reduzieren.", "applyInWork": "Bereitstellung von Vorlagen für Servicevereinbarungen, standardisierten Formaten und Überprüfungsprozessen. Stellen Sie sicher, dass die Teams klare und genau definierte Servicevereinbarungen erstellen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für API-Anbieter und -Kunden festgelegt sind.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Klare Dienstvereinbarungen für jede API definiert", "Erwartungen und Dienstleistungsniveaus für API-Anbieter und Nutzer", "Zuständigkeiten und Unterstützungsprozesse dokumentiert", "Verbesserte Kommunikation und Zusammenarbeit zwischen API-Teams" ], "steps": [ { "text": "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "resourceId": "service-agreement-template", "resourceTitle": "Vorlage für eine Dienstleistungsvereinbarung", "canvasId": null }, { "text": "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "resourceId": "service-agreement-template", "resourceTitle": "Vorlage für eine Dienstleistungsvereinbarung", "canvasId": null }, { "text": "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten.", "resourceId": "service-agreement-template", "resourceTitle": "Vorlage für eine Dienstleistungsvereinbarung", "canvasId": null } ], "questions": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten.", "Bereitstellung von Vorlagen für Servicevereinbarungen, standardisierten Formaten und Überprüfungsprozessen. Stellen Sie sicher, dass die Teams klare und genau definierte Servicevereinbarungen erstellen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für API-Anbieter und -Kunden festgelegt sind.", "Dienstleistungsvereinbarungen sind wichtig, um Klarheit und Übereinstimmung zwischen API-Anbietern und Kunden zu gewährleisten. Diese Station bietet Richtlinien für die Erstellung von Servicevereinbarungen, die Erwartungen, Servicelevel und Verantwortlichkeiten umreißen und so Missverständnisse und Streitigkeiten reduzieren." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "api-consumer-adoption", "slug": "method/api-consumer-adoption", "icon": "chart-data-outline", "title": "Nutzerakzeptanz - Förderung der API-Nutzung", "description": "Implementierung von Strategien zur Förderung der Akzeptanz und des Engagements von Nutzer, um sicherzustellen, dass APIs effektiv genutzt werden.", "whyItMatters": "Die Förderung der Akzeptanz von APIs durch die Nutzer ist entscheidend für die Realisierung des Werts von APIs. Diese Station bietet Strategien und Best Practices für die Einbindung von Nutzern, um sicherzustellen, dass sie verstehen, wie APIs effektiv genutzt werden können und einen Nutzen aus ihnen ziehen.", "applyInWork": "Bereitstellung von Onboarding-Ressourcen, Lehrmaterial und Strategien zur Einbindung von Nutzer. Sicherstellen, dass die Teams Strategien umsetzen, die die Akzeptanz, das Engagement und die Zufriedenheit der Nutzer fördern.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Strategien zur Übernahme von API durch die Nutzer umgesetzt", "Erhöhte API-Nutzung und Engagement", "Nutzer werden über die Funktionen und Vorteile von APIs aufgeklärt", "Verbesserte Zufriedenheit und Loyalität der Nutzer" ], "steps": [ { "text": "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit Nutzer verstehen, wie sie APIs effektiv nutzen können.", "resourceId": "api-onboarding-best-practices", "resourceTitle": "Bewährte Praktiken beim API-Onboarding", "canvasId": null }, { "text": "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null }, { "text": "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null } ], "questions": [ "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit Nutzer verstehen, wie sie APIs effektiv nutzen können.", "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "Bereitstellung von Onboarding-Ressourcen, Lehrmaterial und Strategien zur Einbindung von Nutzer. Sicherstellen, dass die Teams Strategien umsetzen, die die Akzeptanz, das Engagement und die Zufriedenheit der Nutzer fördern.", "Die Förderung der Akzeptanz von APIs durch die Nutzer ist entscheidend für die Realisierung des Werts von APIs. Diese Station bietet Strategien und Best Practices für die Einbindung von Nutzern, um sicherzustellen, dass sie verstehen, wie APIs effektiv genutzt werden können und einen Nutzen aus ihnen ziehen." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "api-promotion", "slug": "method/api-promotion", "icon": "brand-awareness-outline", "title": "API-Promotion - Erhöhen Sie die Sichtbarkeit und Nutzung von APIs", "description": "Förderung von APIs, um die Sichtbarkeit, Nutzung und Akzeptanz bei den Zielgruppen zu erhöhen.", "whyItMatters": "Die Förderung von APIs ist wichtig, um ihre Sichtbarkeit zu erhöhen und ihre Nutzung zu fördern. Diese Station bietet Strategien und Best Practices für eine effektive Werbung für APIs bei den Zielgruppen, um sicherzustellen, dass diese die APIs kennen und ihren Wert verstehen.", "applyInWork": "Bereitstellung von Marketingstrategien, Werbematerialien und Ressourcen für das Engagement in der Gemeinschaft. Sicherstellen, dass die Teams effektive API-Werbestrategien umsetzen, die die Sichtbarkeit, Nutzung und Akzeptanz bei den Zielgruppen erhöhen.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Umgesetzte API-Förderstrategien", "Erhöhte Sichtbarkeit und Bekanntheit von API", "Höhere API-Nutzungs- und Akzeptanzraten", "Verbesserte Nutzerbindung und -zufriedenheit" ], "steps": [ { "text": "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null }, { "text": "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null }, { "text": "Engagieren Sie sich in API-Gemeinschaften und Foren, um API-Aktualisierungen weiterzugeben, Feedback zu sammeln und die API-Nutzung zu fördern.", "resourceId": "api-community-engagement-strategies", "resourceTitle": "Strategien für das Engagement der API-Gemeinschaft", "canvasId": null } ], "questions": [ "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "Engagieren Sie sich in API-Gemeinschaften und Foren, um API-Aktualisierungen weiterzugeben, Feedback zu sammeln und die API-Nutzung zu fördern.", "Bereitstellung von Marketingstrategien, Werbematerialien und Ressourcen für das Engagement in der Gemeinschaft. Sicherstellen, dass die Teams effektive API-Werbestrategien umsetzen, die die Sichtbarkeit, Nutzung und Akzeptanz bei den Zielgruppen erhöhen.", "Die Förderung von APIs ist wichtig, um ihre Sichtbarkeit zu erhöhen und ihre Nutzung zu fördern. Diese Station bietet Strategien und Best Practices für eine effektive Werbung für APIs bei den Zielgruppen, um sicherzustellen, dass diese die APIs kennen und ihren Wert verstehen." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "partner-integration", "slug": "method/partner-integration", "icon": "integration-instructions-outline", "title": "Partnerintegration - Zusammenarbeit mit Partnern", "description": "Erleichtern Sie die Integration von Partnern, um die API-Funktionen zu verbessern und die Reichweite zu erhöhen.", "whyItMatters": "Die Integration von Partnern kann die API-Funktionen verbessern und die Reichweite erhöhen. Diese Station enthält Richtlinien für die Zusammenarbeit mit Partnern zur Integration ihrer APIs, um nahtlose Interoperabilität und Wertschöpfung zu gewährleisten.", "applyInWork": "Bereitstellung von Frameworks, Richtlinien und Überwachungstools für die Partnerintegration. Sicherstellen, dass die Teams effektiv mit Partnern zusammenarbeiten, um die API-Funktionen zu verbessern, die Reichweite zu erhöhen und Innovationen voranzutreiben.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Prozesse zur Partnerintegration etabliert", "Verbesserte API-Funktionen durch Partner-APIs", "Erhöhte Reichweite und Marktchancen durch Partnerschaften", "Verbesserte Zusammenarbeit und Innovation mit Partnern" ], "steps": [ { "text": "Identifizieren Sie potenzielle Partner, deren APIs Ihre API-Fähigkeiten und Ihr Wertversprechen verbessern können.", "resourceId": "ecosystem-vision-template", "resourceTitle": "Ökosystem Vision Vorlage", "canvasId": null }, { "text": "Festlegung von Integrationsprozessen und Richtlinien für die Zusammenarbeit mit Partnern, einschließlich technischer Integration, Datenaustausch und Unterstützung.", "resourceId": "partner-integration-guidelines", "resourceTitle": "Leitlinien für die Integration von Partnern", "canvasId": null }, { "text": "Überwachen Sie die API-Leistung und -Einhaltung der Partner, um Zuverlässigkeit und Übereinstimmung mit Ihrer API-Strategie zu gewährleisten.", "resourceId": "partner-integration-guidelines", "resourceTitle": "Leitlinien für die Integration von Partnern", "canvasId": null } ], "questions": [ "Identifizieren Sie potenzielle Partner, deren APIs Ihre API-Fähigkeiten und Ihr Wertversprechen verbessern können.", "Festlegung von Integrationsprozessen und Richtlinien für die Zusammenarbeit mit Partnern, einschließlich technischer Integration, Datenaustausch und Unterstützung.", "Überwachen Sie die API-Leistung und -Einhaltung der Partner, um Zuverlässigkeit und Übereinstimmung mit Ihrer API-Strategie zu gewährleisten.", "Bereitstellung von Frameworks, Richtlinien und Überwachungstools für die Partnerintegration. Sicherstellen, dass die Teams effektiv mit Partnern zusammenarbeiten, um die API-Funktionen zu verbessern, die Reichweite zu erhöhen und Innovationen voranzutreiben.", "Die Integration von Partnern kann die API-Funktionen verbessern und die Reichweite erhöhen. Diese Station enthält Richtlinien für die Zusammenarbeit mit Partnern zur Integration ihrer APIs, um nahtlose Interoperabilität und Wertschöpfung zu gewährleisten." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "api-mindset", "slug": "method/api-mindset", "icon": "psychology-outline", "title": "API-Mentalität - Fördern Sie eine API-First-Kultur", "description": "Fördern Sie eine API-zentrierte Denkweise im gesamten Unternehmen, um Innovation und Zusammenarbeit voranzutreiben.", "whyItMatters": "Eine API-zentrierte Denkweise ist entscheidend für die Förderung von Innovation und Zusammenarbeit im gesamten Unternehmen. Diese Station bietet Strategien für die Kultivierung einer API-first-Kultur, die sicherstellt, dass APIs als strategische Assets betrachtet werden, die den Geschäftswert steigern.", "applyInWork": "Bereitstellung von Schulungsprogrammen, Ressourcen und Kommunikationsstrategien zur Förderung einer API-zentrierten Kultur. Sicherstellen, dass die Teams den Wert von APIs verstehen und befähigt werden, die API-Strategie und -Initiativen voranzutreiben.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Einführung einer API-zentrierten Kultur im gesamten Unternehmen", "Verbesserte Innovation und Zusammenarbeit durch APIs", "API-Teams, die in der Lage sind, die API-Strategie und -Initiativen voranzutreiben", "Verbesserte Abstimmung zwischen Geschäftszielen und API-Entwicklung" ], "steps": [ { "text": "Förderung des Wertes von APIs als strategische Ressourcen, die den Geschäftswert und die Innovation vorantreiben.", "resourceId": "ecosystem-vision-template", "resourceTitle": "Ökosystem Vision Vorlage", "canvasId": null }, { "text": "Fördern Sie die funktionsübergreifende Zusammenarbeit zwischen API-Teams, Geschäftseinheiten und Interessenvertretern, um API-Initiativen mit den Geschäftszielen abzustimmen.", "resourceId": "cross-functional-collaboration-best-practices", "resourceTitle": "Best Practices für die funktionsübergreifende Zusammenarbeit", "canvasId": null }, { "text": "Bereitstellung von Schulungen und Ressourcen, um Teams dabei zu helfen, eine API-first-Mentalität zu entwickeln und die Vorteile von APIs zu verstehen.", "resourceId": "api-training-programs", "resourceTitle": "API-Schulungsprogramme", "canvasId": null } ], "questions": [ "Förderung des Wertes von APIs als strategische Ressourcen, die den Geschäftswert und die Innovation vorantreiben.", "Fördern Sie die funktionsübergreifende Zusammenarbeit zwischen API-Teams, Geschäftseinheiten und Interessenvertretern, um API-Initiativen mit den Geschäftszielen abzustimmen.", "Bereitstellung von Schulungen und Ressourcen, um Teams dabei zu helfen, eine API-first-Mentalität zu entwickeln und die Vorteile von APIs zu verstehen.", "Bereitstellung von Schulungsprogrammen, Ressourcen und Kommunikationsstrategien zur Förderung einer API-zentrierten Kultur. Sicherstellen, dass die Teams den Wert von APIs verstehen und befähigt werden, die API-Strategie und -Initiativen voranzutreiben.", "Eine API-zentrierte Denkweise ist entscheidend für die Förderung von Innovation und Zusammenarbeit im gesamten Unternehmen. Diese Station bietet Strategien für die Kultivierung einer API-first-Kultur, die sicherstellt, dass APIs als strategische Assets betrachtet werden, die den Geschäftswert steigern." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "roles-and-responsibilities", "slug": "method/roles-and-responsibilities", "icon": "manage-accounts-outline", "title": "Rollen und Zuständigkeiten - API-Team-Strukturen definieren", "description": "Definieren Sie klare Rollen und Verantwortlichkeiten für API-Teams, um eine effektive Zusammenarbeit und Verantwortlichkeit zu gewährleisten.", "whyItMatters": "Klare Rollen und Zuständigkeiten sind für eine effektive Zusammenarbeit und Verantwortlichkeit in API-Teams unerlässlich. Diese Station bietet Richtlinien für die Definition von Teamstrukturen, Rollen und Verantwortlichkeiten, um sicherzustellen, dass jeder seinen Beitrag zu API-Initiativen versteht.", "applyInWork": "Bereitstellung von Richtlinien für die Teamstruktur, Rollendefinitionen und Kommunikationsstrategien. Stellen Sie sicher, dass Teams klare Rollen und Verantwortlichkeiten haben, die eine effektive Zusammenarbeit und Verantwortlichkeit bei API-Initiativen fördern.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Klare Rollen und Verantwortlichkeiten für API-Teams definiert", "Effektive Zusammenarbeit und Verantwortlichkeit innerhalb der API-Teams", "Verbesserte Kommunikation und Abstimmung zwischen den Teammitgliedern", "Weniger Verwirrung und Überschneidungen bei den Zuständigkeiten" ], "steps": [ { "text": "Definieren Sie Teamstrukturen und Rollen für API-Teams, einschließlich API-Produktverantwortliche, Entwickler, Architekten und Betriebsleiter.", "resourceId": "api-team-structure-guidelines", "resourceTitle": "Leitlinien für die API-Teamstruktur", "canvasId": null }, { "text": "Legen Sie klare Verantwortlichkeiten für jede Rolle fest, einschließlich API-Design, Entwicklung, Testen und Betrieb.", "resourceId": "role-communication-best-practices", "resourceTitle": "Bewährte Praktiken der Rollenkommunikation", "canvasId": null }, { "text": "Sicherstellen, dass die Rollen und Verantwortlichkeiten allen Teammitgliedern und Interessenvertretern mitgeteilt werden, um eine Abstimmung zu gewährleisten.", "resourceId": "role-communication-best-practices", "resourceTitle": "Bewährte Praktiken der Rollenkommunikation", "canvasId": null } ], "questions": [ "Definieren Sie Teamstrukturen und Rollen für API-Teams, einschließlich API-Produktverantwortliche, Entwickler, Architekten und Betriebsleiter.", "Legen Sie klare Verantwortlichkeiten für jede Rolle fest, einschließlich API-Design, Entwicklung, Testen und Betrieb.", "Sicherstellen, dass die Rollen und Verantwortlichkeiten allen Teammitgliedern und Interessenvertretern mitgeteilt werden, um eine Abstimmung zu gewährleisten.", "Bereitstellung von Richtlinien für die Teamstruktur, Rollendefinitionen und Kommunikationsstrategien. Stellen Sie sicher, dass Teams klare Rollen und Verantwortlichkeiten haben, die eine effektive Zusammenarbeit und Verantwortlichkeit bei API-Initiativen fördern.", "Klare Rollen und Zuständigkeiten sind für eine effektive Zusammenarbeit und Verantwortlichkeit in API-Teams unerlässlich. Diese Station bietet Richtlinien für die Definition von Teamstrukturen, Rollen und Verantwortlichkeiten, um sicherzustellen, dass jeder seinen Beitrag zu API-Initiativen versteht." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "upskilling", "slug": "method/upskilling", "icon": "school-outline", "title": "Upskilling - Erweiterung der API-Fähigkeiten und -Kenntnisse", "description": "Bereitstellung von Schulungen und Ressourcen zur Verbesserung der API-Fähigkeiten und -Kenntnisse in der gesamten Organisation.", "whyItMatters": "Kontinuierliches Lernen und Weiterbildung sind unerlässlich, um API-Teams mit den neuesten Technologien, Praktiken und Trends auf dem Laufenden zu halten. Diese Station bietet Schulungsprogramme und Ressourcen zur Verbesserung der API-Fähigkeiten und -Kenntnisse, um sicherzustellen, dass die Teams für die Bereitstellung hochwertiger APIs gerüstet sind.", "applyInWork": "Bereitstellung von Schulungsprogrammen, Ressourcen und Bewertungsinstrumenten zur Verbesserung der API-Fähigkeiten und -Kenntnisse. Sicherstellen, dass Teams Zugang zu kontinuierlichen Lernmöglichkeiten haben, die sie befähigen, API-Innovation und Qualität voranzutreiben.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Verbesserung der API-Fähigkeiten und -Kenntnisse in der gesamten Organisation", "Erhöhte Kompetenz bei der Konzeption, Entwicklung und Verwaltung von APIs", "Verbesserte Fähigkeit zur Übernahme neuer Technologien und Verfahren", "Befähigte Teams zur Förderung von API-Innovation und -Qualität" ], "steps": [ { "text": "Identifizieren Sie wichtige API-Fähigkeiten und Wissensbereiche, die verbessert werden müssen, wie z. B. API-Design, Sicherheit und Leistung.", "resourceId": "api-training-programs", "resourceTitle": "API-Schulungsprogramme", "canvasId": null } ], "questions": [ "Identifizieren Sie wichtige API-Fähigkeiten und Wissensbereiche, die verbessert werden müssen, wie z. B. API-Design, Sicherheit und Leistung.", "Bereitstellung von Schulungsprogrammen, Ressourcen und Bewertungsinstrumenten zur Verbesserung der API-Fähigkeiten und -Kenntnisse. Sicherstellen, dass Teams Zugang zu kontinuierlichen Lernmöglichkeiten haben, die sie befähigen, API-Innovation und Qualität voranzutreiben.", "Kontinuierliches Lernen und Weiterbildung sind unerlässlich, um API-Teams mit den neuesten Technologien, Praktiken und Trends auf dem Laufenden zu halten. Diese Station bietet Schulungsprogramme und Ressourcen zur Verbesserung der API-Fähigkeiten und -Kenntnisse, um sicherzustellen, dass die Teams für die Bereitstellung hochwertiger APIs gerüstet sind." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "operating-guidelines", "slug": "method/operating-guidelines", "icon": "list-alt-outline", "title": "Betriebsleitlinien - Einrichtung einer API-Governance", "description": "Festlegung von Betriebsrichtlinien und Governance-Praktiken zur Gewährleistung einer einheitlichen API-Verwaltung und -Qualität.", "whyItMatters": "Eine effektive API-Governance ist für die Sicherstellung einer konsistenten API-Verwaltung, Qualität und Compliance unerlässlich. Diese Station bietet Betriebsrichtlinien und Governance-Praktiken, die Teams bei der effektiven Verwaltung von APIs helfen und sicherstellen, dass diese mit den Unternehmensstandards und Best Practices übereinstimmen.", "applyInWork": "Bereitstellung von Betriebsrichtlinien, Governance-Frameworks und Überwachungstools für die API-Verwaltung. Sicherstellen, dass Teams etablierte Praktiken befolgen, die eine konsistente API-Verwaltung, Qualität und die Einhaltung von Unternehmensstandards fördern.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "API-Governance-Verfahren eingeführt", "Konsistente API-Verwaltung und -Qualität im gesamten Unternehmen", "Einhaltung von Organisationsstandards und bewährten Verfahren", "Verbesserte Sichtbarkeit und Kontrolle über API-Initiativen" ], "steps": [ { "text": "Definieren Sie Betriebsrichtlinien auf der Grundlage von APIOps-Zyklen, die die Prozesse, Standards und bewährten Verfahren für die API-Verwaltung umreißen.", "resourceId": "", "resourceTitle": "", "canvasId": null }, { "text": "Etablieren Sie Governance-Praktiken, die sicherstellen, dass APIs einheitlich verwaltet werden, einschließlich Überprüfungen, Audits und Compliance-Checks.", "resourceId": "", "resourceTitle": "", "canvasId": null }, { "text": "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten", "resourceId": "api-metrics-and-analytics", "resourceTitle": "API-Metriken und -Analysen", "canvasId": null } ], "questions": [ "Definieren Sie Betriebsrichtlinien auf der Grundlage von APIOps-Zyklen, die die Prozesse, Standards und bewährten Verfahren für die API-Verwaltung umreißen.", "Etablieren Sie Governance-Praktiken, die sicherstellen, dass APIs einheitlich verwaltet werden, einschließlich Überprüfungen, Audits und Compliance-Checks.", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten", "Bereitstellung von Betriebsrichtlinien, Governance-Frameworks und Überwachungstools für die API-Verwaltung. Sicherstellen, dass Teams etablierte Praktiken befolgen, die eine konsistente API-Verwaltung, Qualität und die Einhaltung von Unternehmensstandards fördern.", "Eine effektive API-Governance ist für die Sicherstellung einer konsistenten API-Verwaltung, Qualität und Compliance unerlässlich. Diese Station bietet Betriebsrichtlinien und Governance-Praktiken, die Teams bei der effektiven Verwaltung von APIs helfen und sicherstellen, dass diese mit den Unternehmensstandards und Best Practices übereinstimmen." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "portfolio-management", "slug": "method/portfolio-management", "icon": "cases-outline", "title": "Portfoliomanagement - Effektive Verwaltung des API-Portfolios", "description": "Effiziente Verwaltung des API-Portfolios, um die Übereinstimmung mit den Geschäftszielen und strategischen Initiativen zu gewährleisten.", "whyItMatters": "Eine effektive Verwaltung des API-Portfolios ist unerlässlich, um sicherzustellen, dass APIs mit den Geschäftszielen und strategischen Initiativen übereinstimmen. Diese Station bietet Richtlinien für die Verwaltung des API-Portfolios und stellt sicher, dass APIs priorisiert, überwacht und optimiert werden, um maximalen Wert zu liefern.", "applyInWork": "Bereitstellung von Rahmenwerken für das Portfoliomanagement, Priorisierungskriterien und Überwachungstools für das API-Management. Sicherstellen, dass die Teams das API-Portfolio effektiv verwalten und dabei die Ausrichtung an Geschäftszielen und strategischen Initiativen sowie die Bereitstellung eines maximalen Werts gewährleisten.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Einführung von API-Portfolioverwaltungspraktiken", "APIs im Einklang mit Unternehmenszielen und strategischen Initiativen", "Priorisierung und Optimierung von APIs auf der Grundlage von Wert und Wirkung", "Verbesserte Sichtbarkeit und Kontrolle über das API-Portfolio" ], "steps": [ { "text": "Definition von Portfoliomanagementverfahren, die die Prozesse zur Verwaltung des API-Portfolios, einschließlich Priorisierung, Überwachung und Optimierung, umreißen.", "resourceId": "api-portfolio-management-guidelines", "resourceTitle": "Leitlinien für das API-Portfolio-Management", "canvasId": null } ], "questions": [ "Definition von Portfoliomanagementverfahren, die die Prozesse zur Verwaltung des API-Portfolios, einschließlich Priorisierung, Überwachung und Optimierung, umreißen.", "Bereitstellung von Rahmenwerken für das Portfoliomanagement, Priorisierungskriterien und Überwachungstools für das API-Management. Sicherstellen, dass die Teams das API-Portfolio effektiv verwalten und dabei die Ausrichtung an Geschäftszielen und strategischen Initiativen sowie die Bereitstellung eines maximalen Werts gewährleisten.", "Eine effektive Verwaltung des API-Portfolios ist unerlässlich, um sicherzustellen, dass APIs mit den Geschäftszielen und strategischen Initiativen übereinstimmen. Diese Station bietet Richtlinien für die Verwaltung des API-Portfolios und stellt sicher, dass APIs priorisiert, überwacht und optimiert werden, um maximalen Wert zu liefern." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] }, { "id": "budget-and-resource-management", "slug": "method/budget-and-resource-management", "icon": "money-bag-outline", "title": "Budget- und Ressourcenmanagement - Optimierung von API-Investitionen", "description": "Optimieren Sie das Budget- und Ressourcenmanagement für API-Initiativen, um eine effektive Investition und Ressourcenzuweisung zu gewährleisten.", "whyItMatters": "Ein effektives Budget- und Ressourcenmanagement ist unerlässlich, um sicherzustellen, dass API-Initiativen gut finanziert und mit Ressourcen ausgestattet sind. Diese Station bietet Richtlinien für die Optimierung der Budget- und Ressourcenverwaltung, um sicherzustellen, dass API-Initiativen mit den Unternehmenszielen übereinstimmen und maximalen Wert liefern.", "applyInWork": "Bereitstellung von Rahmenwerken für die Budgetverwaltung, Priorisierungskriterien und Überwachungsinstrumenten für API-Initiativen. Sicherstellen, dass die Teams Budgets und Ressourcen effektiv verwalten und die Investitionen in die API-Entwicklung und -Verwaltung optimieren, um einen maximalen Nutzen zu erzielen.", "group": "Unterstützende Stationen", "lifecycleStage": "supporting", "outcomes": [ "Budget- und Ressourcenmanagementverfahren für API-Initiativen eingeführt", "Effiziente Zuweisung von Ressourcen für API-Initiativen", "Optimierte Investitionen in die API-Entwicklung und -Verwaltung", "Verbesserte finanzielle Transparenz und Kontrolle über API-Initiativen" ], "steps": [ { "text": "Definieren Sie Budget- und Ressourcenverwaltungspraktiken, die die Prozesse für die Verwaltung von Budgets und Ressourcen für API-Initiativen umreißen.", "resourceId": "api-portfolio-management-guidelines", "resourceTitle": "Leitlinien für das API-Portfolio-Management", "canvasId": null } ], "questions": [ "Definieren Sie Budget- und Ressourcenverwaltungspraktiken, die die Prozesse für die Verwaltung von Budgets und Ressourcen für API-Initiativen umreißen.", "Bereitstellung von Rahmenwerken für die Budgetverwaltung, Priorisierungskriterien und Überwachungsinstrumenten für API-Initiativen. Sicherstellen, dass die Teams Budgets und Ressourcen effektiv verwalten und die Investitionen in die API-Entwicklung und -Verwaltung optimieren, um einen maximalen Nutzen zu erzielen.", "Ein effektives Budget- und Ressourcenmanagement ist unerlässlich, um sicherzustellen, dass API-Initiativen gut finanziert und mit Ressourcen ausgestattet sind. Diese Station bietet Richtlinien für die Optimierung der Budget- und Ressourcenverwaltung, um sicherzustellen, dass API-Initiativen mit den Unternehmenszielen übereinstimmen und maximalen Wert liefern." ], "criteria": [], "criteriaDetails": [], "stakeholders": [], "evidence": [] } ], "stakeholders": [ { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "" }, { "id": "api-architect", "sourceKey": "api-architect", "sourceStakeholderId": "api-architect", "title": "API-Architekt", "description": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "involvement": "" }, { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "" }, { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "" }, { "id": "api-program-owner", "sourceKey": "api-program-owner", "sourceStakeholderId": "api-program-owner", "title": "API-Programmverantwortlicher", "description": "Koordiniert API-Portfolio-Praktiken, organisatorische Ausrichtung und langfristige Entwicklung von API-Capabilities.", "involvement": "" }, { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "" }, { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "" }, { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "" }, { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "" }, { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "" }, { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "" }, { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "" }, { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "" }, { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "" }, { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "" }, { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "" }, { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "" }, { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "" }, { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "" }, { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "" }, { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "" }, { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "" } ], "routeProfiles": [ { "id": "api-product-owner", "stakeholderId": "api-product-owner", "title": "API Product Owner", "summary": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "stakeholder": { "id": "api-product-owner", "sourceKey": "api-product-owner", "sourceStakeholderId": "api-product-owner", "title": "API Product Owner", "description": "Steuert API-Chance, Priorisierung und produktbezogene Entscheidungen über den gesamten Lebenszyklus hinweg.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." } ], "stations": [ { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "apiBusinessModelCanvas", "title": "API Business Model Canvas" } ], "decisions": [ "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen." ], "outputs": [ "Validierte Architektur- und Plattformentscheidung", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit", "architecture-decision", "documentation", "platform-config", "metrics", "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise" ], "recommendedResources": [ { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true }, { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "promptIds": [ "api-product-owner:facilitate-station", "api-product-owner:use-resources", "api-product-owner:next-actions" ] }, { "id": "api-architect", "stakeholderId": "api-architect", "title": "API-Architekt", "summary": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "stakeholder": { "id": "api-architect", "sourceKey": "api-architect", "sourceStakeholderId": "api-architect", "title": "API-Architekt", "description": "Verantwortet API-Architektur, Entwurfsprinzipien und die Qualität der Schnittstellenverträge.", "involvement": "" }, "cycles": [ { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." } ], "stations": [ { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." } ], "canvases": [ { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" } ], "decisions": [ "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen." ], "outputs": [ "Validierte Architektur- und Plattformentscheidung", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit", "architecture-decision", "documentation", "platform-config", "metrics" ], "recommendedResources": [ { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "partner-integration-guidelines", "slug": "resources/partner-integration-guidelines", "title": "Leitlinien für die Integration von Partnern", "description": "Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.", "category": "guideline", "icon": "edit-document-outline", "order": 164, "outcomes": [ "Besseres Verständnis der Grundsätze der Leitlinien für die Integration von Partnern", "Standardisierter Ansatz unter Verwendung der Richtlinien zur Partnerintegration", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Festlegung von Integrationsprozessen und Richtlinien für die Zusammenarbeit mit Partnern, einschließlich technischer Integration, Datenaustausch und Unterstützung.", "Überwachen Sie die API-Leistung und -Einhaltung der Partner, um Zuverlässigkeit und Übereinstimmung mit Ihrer API-Strategie zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "api-architect:facilitate-station", "api-architect:use-resources", "api-architect:next-actions" ] }, { "id": "api-designer", "stakeholderId": "api-designer", "title": "API-Designer", "summary": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "stakeholder": { "id": "api-designer", "sourceKey": "api-designer", "sourceStakeholderId": "api-designer", "title": "API-Designer", "description": "Gestaltet Schnittstellenvertrag, Interaktionsmodell, Konsistenz, Benutzerfreundlichkeit und bereitgestellte Capabilities.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." } ], "canvases": [ { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" } ], "decisions": [ "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen.", "Verwenden Sie das Interaction Canvas, um zu definieren, wie die Nutzer mit der API interagieren werden, um sicherzustellen, dass sie ihren Bedürfnissen und Erwartungen entspricht.", "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare Schnittstellenverträge zu erstellen, die mit den Beteiligten validiert werden.", "Nutzen Sie die Designprinzipien und den API-Styleguide, um Ihre Designentscheidungen an gemeinsamen Regeln auszurichten und eine konsistente Audit-Validierung zu ermöglichen." ], "outputs": [ "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise", "Wiederverwendbare und validierte Schnittstellenverträge", "Entwürfe, die auf Domänenmodelle und Interaktionsmuster abgestimmt sind", "Rückverfolgbarkeit des Designs zum Geschäftswert", "spec", "contract", "design-artifact", "documentation" ], "recommendedResources": [ { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true }, { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false }, { "id": "api-compliance-best-practices", "slug": "resources/api-compliance-best-practices", "title": "Bewährte Praktiken zur API-Einhaltung", "description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 104, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "api-designer:facilitate-station", "api-designer:use-resources", "api-designer:next-actions" ] }, { "id": "api-engineer", "stakeholderId": "api-engineer", "title": "API-Entwickler", "summary": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "stakeholder": { "id": "api-engineer", "sourceKey": "api-engineer", "sourceStakeholderId": "api-engineer", "title": "API-Entwickler", "description": "Verantwortet Implementierung, Automatisierung, Tests und Release-Abläufe, die für die zuverlässige Bereitstellung der Capability, API oder Automatisierung erforderlich sind.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" } ], "decisions": [ "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.", "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags 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." ], "outputs": [ "Eine bereitgestellte Capability, die mit dem validierten Schnittstellenvertrag übereinstimmt", "Zuverlässige und automatisierte CI/CD-Pipelines", "Funktionale und nicht-funktionale Tests integriert", "Sichere und gesetzeskonforme Bereitstellungspipelines", "implementation", "pipeline-config", "test-report", "security-report" ], "recommendedResources": [ { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false }, { "id": "api-compliance-best-practices", "slug": "resources/api-compliance-best-practices", "title": "Bewährte Praktiken zur API-Einhaltung", "description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 104, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "promptIds": [ "api-engineer:facilitate-station", "api-engineer:use-resources", "api-engineer:next-actions" ] }, { "id": "automation-engineer", "stakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "summary": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "stakeholder": { "id": "automation-engineer", "sourceKey": "automation-engineer", "sourceStakeholderId": "automation-engineer", "title": "Automatisierungsingenieur", "description": "Implementiert, testet, integriert und betreibt Automatisierungslösungen und unterstützende Workflows.", "involvement": "" }, "cycles": [ { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" } ], "decisions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "outputs": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung", "design-artifact", "documentation", "research", "roadmap", "Validierte Architektur- und Plattformentscheidung" ], "recommendedResources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "automation-operational-ownership-guide", "slug": "resources/automation-operational-ownership-guide", "title": "Leitfaden für die betriebliche Verantwortung von Automatisierungen", "description": "Orientierung zur Definition von Verantwortung, Runbooks, Überwachung, Support, Monitoring, Änderungskontrolle und kontinuierlicher Verbesserung für Automatisierungen.", "category": "guideline", "icon": "edit-document-outline", "order": 185, "outcomes": [ "Klares Betriebsmodell für die Automatisierung", "Verantwortlichkeiten für Eigentum, Support und Eskalation zugewiesen", "Monitoring- und Änderungspraktiken für den Live-Betrieb bereit" ], "steps": [ "Definieren Sie fachliche, technische und betriebliche Verantwortliche für die Automatisierung.", "Dokumentieren Sie Runbooks, Supportwege, Monitoring-Signale, Serviceerwartungen und Eskalationsregeln.", "Legen Sie Änderungskontrolle und Review-Praktiken für Workflow-, Plattform- und Regeländerungen fest." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "process-workflow-design-guide", "slug": "resources/process-workflow-design-guide", "title": "Leitfaden für Prozess- und Workflow-Design", "description": "Orientierung zur Modellierung von Prozessschritten, Rollen, Übergaben, Entscheidungspunkten, Zuständen, Eingaben, Ausgaben und Ausnahmen, die einen Automatisierungs-Workflow prägen.", "category": "guideline", "icon": "edit-document-outline", "order": 181, "outcomes": [ "Klares Design des Automatisierungs-Workflows", "Prozessschritte und Übergaben vor der Implementierung dokumentiert", "Workflow-Zustände, Eingaben, Ausgaben und Ausnahmewege verstanden" ], "steps": [ "Modellieren Sie den aktuellen und den Ziel-Prozessfluss einschließlich menschlicher und systemseitiger Verantwortlichkeiten.", "Identifizieren Sie Workflow-Auslöser, Zustände, Entscheidungen, Dateneingaben, Ausgaben und Abschlusskriterien.", "Dokumentieren Sie Übergaben zwischen Nutzern, Systemen, Betrieb und Supportrollen.", "Bestätigen Sie, welche Schritte automatisiert werden sollen und welche menschliches Urteilsvermögen erfordern." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "decision-business-rules-guide", "slug": "resources/decision-business-rules-guide", "title": "Leitfaden für Entscheidungen und Geschäftsregeln", "description": "Orientierung zur Erfassung von Regeln, Schwellenwerten, Entscheidungen, Genehmigungen, Eignungsprüfungen und Regelverantwortung für das Automatisierungsdesign.", "category": "guideline", "icon": "edit-document-outline", "order": 182, "outcomes": [ "Explizite Entscheidungen und Geschäftsregeln", "Regeln und Schwellenwerte mit Verantwortlichen dokumentiert", "Automatisierungsentscheidungen auf Richtlinien, Prozesse oder Geschäftsabsicht zurückführbar" ], "steps": [ "Listen Sie Entscheidungen auf, die die Automatisierung treffen oder unterstützen muss.", "Dokumentieren Sie Regelbedingungen, Schwellenwerte, Ausnahmen, Genehmigungen und Eskalationspunkte.", "Identifizieren Sie Regelverantwortliche und Änderungsgovernance für jeden Entscheidungsbereich." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "automation-engineer:facilitate-station", "automation-engineer:use-resources", "automation-engineer:next-actions" ] }, { "id": "automation-owner", "stakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "summary": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "stakeholder": { "id": "automation-owner", "sourceKey": "automation-owner", "sourceStakeholderId": "automation-owner", "title": "Automatisierungsverantwortlicher", "description": "Verantwortet Ziele, Geschäftswert, Prioritäten, Kontrollen und Lebenszyklusergebnisse der Automatisierung.", "involvement": "" }, "cycles": [ { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" } ], "decisions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "outputs": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung", "design-artifact", "documentation", "research", "roadmap", "Explizite Nutzeranforderungen und Onboarding-Erwartungen" ], "recommendedResources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "automation-operational-ownership-guide", "slug": "resources/automation-operational-ownership-guide", "title": "Leitfaden für die betriebliche Verantwortung von Automatisierungen", "description": "Orientierung zur Definition von Verantwortung, Runbooks, Überwachung, Support, Monitoring, Änderungskontrolle und kontinuierlicher Verbesserung für Automatisierungen.", "category": "guideline", "icon": "edit-document-outline", "order": 185, "outcomes": [ "Klares Betriebsmodell für die Automatisierung", "Verantwortlichkeiten für Eigentum, Support und Eskalation zugewiesen", "Monitoring- und Änderungspraktiken für den Live-Betrieb bereit" ], "steps": [ "Definieren Sie fachliche, technische und betriebliche Verantwortliche für die Automatisierung.", "Dokumentieren Sie Runbooks, Supportwege, Monitoring-Signale, Serviceerwartungen und Eskalationsregeln.", "Legen Sie Änderungskontrolle und Review-Praktiken für Workflow-, Plattform- und Regeländerungen fest." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "process-workflow-design-guide", "slug": "resources/process-workflow-design-guide", "title": "Leitfaden für Prozess- und Workflow-Design", "description": "Orientierung zur Modellierung von Prozessschritten, Rollen, Übergaben, Entscheidungspunkten, Zuständen, Eingaben, Ausgaben und Ausnahmen, die einen Automatisierungs-Workflow prägen.", "category": "guideline", "icon": "edit-document-outline", "order": 181, "outcomes": [ "Klares Design des Automatisierungs-Workflows", "Prozessschritte und Übergaben vor der Implementierung dokumentiert", "Workflow-Zustände, Eingaben, Ausgaben und Ausnahmewege verstanden" ], "steps": [ "Modellieren Sie den aktuellen und den Ziel-Prozessfluss einschließlich menschlicher und systemseitiger Verantwortlichkeiten.", "Identifizieren Sie Workflow-Auslöser, Zustände, Entscheidungen, Dateneingaben, Ausgaben und Abschlusskriterien.", "Dokumentieren Sie Übergaben zwischen Nutzern, Systemen, Betrieb und Supportrollen.", "Bestätigen Sie, welche Schritte automatisiert werden sollen und welche menschliches Urteilsvermögen erfordern." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "automation-owner:facilitate-station", "automation-owner:use-resources", "automation-owner:next-actions" ] }, { "id": "business-owner", "stakeholderId": "business-owner", "title": "Business Owner", "summary": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "stakeholder": { "id": "business-owner", "sourceKey": "business-owner", "sourceStakeholderId": "business-owner", "title": "Business Owner", "description": "Vertritt Geschäftsziele, Finanzierung und erwartete Ergebnisse der Capability-, API- oder Automatisierungsinitiative.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "apiBusinessModelCanvas", "title": "API Business Model Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" } ], "decisions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "outputs": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung", "design-artifact", "documentation", "research", "roadmap", "Explizite Nutzeranforderungen und Onboarding-Erwartungen" ], "recommendedResources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "service-agreement-template", "slug": "resources/service-agreement-template", "title": "Vorlage für eine Dienstleistungsvereinbarung", "description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "category": "guideline", "icon": "edit-document-outline", "order": 172, "outcomes": [ "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "business-owner:facilitate-station", "business-owner:use-resources", "business-owner:next-actions" ] }, { "id": "capability-owner", "stakeholderId": "capability-owner", "title": "Capability Owner", "summary": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "stakeholder": { "id": "capability-owner", "sourceKey": "capability-owner", "sourceStakeholderId": "capability-owner", "title": "Capability Owner", "description": "Verantwortet Vision, Wert, Prioritäten, Lebenszyklus und Wiederverwendung der Capability über Nutzer hinweg.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." } ], "stations": [ { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" } ], "decisions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "outputs": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung", "design-artifact", "documentation", "research", "roadmap", "Explizite Nutzeranforderungen und Onboarding-Erwartungen" ], "recommendedResources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "promptIds": [ "capability-owner:facilitate-station", "capability-owner:use-resources", "capability-owner:next-actions" ] }, { "id": "compliance-specialist", "stakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "summary": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "stakeholder": { "id": "compliance-specialist", "sourceKey": "compliance-specialist", "sourceStakeholderId": "compliance-specialist", "title": "Compliance- und Rechtsexperte", "description": "Klärt rechtliche, Datenschutz-, regulatorische und vertragliche Anforderungen, die Capability, API, Schnittstelle oder Automatisierung betreffen.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "apiBusinessModelCanvas", "title": "API Business Model Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" } ], "decisions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "outputs": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung", "design-artifact", "documentation", "research", "roadmap", "Validierte Architektur- und Plattformentscheidung" ], "recommendedResources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "compliance-specialist:facilitate-station", "compliance-specialist:use-resources", "compliance-specialist:next-actions" ] }, { "id": "domain-specialist", "stakeholderId": "domain-specialist", "title": "Domain-Experte", "summary": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "stakeholder": { "id": "domain-specialist", "sourceKey": "domain-specialist", "sourceStakeholderId": "domain-specialist", "title": "Domain-Experte", "description": "Bringt tiefes Wissen über Geschäftsdomäne, Konzepte, Regeln und Einschränkungen ein, die die Capability oder Schnittstelle widerspiegeln muss.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "apiBusinessModelCanvas", "title": "API Business Model Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" } ], "decisions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "outputs": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung", "design-artifact", "documentation", "research", "roadmap", "Explizite Nutzeranforderungen und Onboarding-Erwartungen" ], "recommendedResources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true }, { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "promptIds": [ "domain-specialist:facilitate-station", "domain-specialist:use-resources", "domain-specialist:next-actions" ] }, { "id": "governance-specialist", "stakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "summary": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "stakeholder": { "id": "governance-specialist", "sourceKey": "governance-specialist", "sourceStakeholderId": "governance-specialist", "title": "Governance-Verantwortlicher", "description": "Repräsentiert Überprüfung, Auditierung und organisationsweite Governance-Praktiken für API-Qualität und Konformität.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." } ], "canvases": [], "decisions": [ "Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.", "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.", "Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.", "Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung." ], "outputs": [ "Dokumentierte Bereitschaft für Veröffentlichung und Wiederverwendung", "Klare Dokumentation des API-Designs und der Implementierungsentscheidungen", "Sicherheit, Leistung und Compliance validiert", "Geringeres Risiko von Problemen in der Produktion", "audit-report", "compliance-report", "security-report", "test-report" ], "recommendedResources": [ { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false }, { "id": "api-compliance-best-practices", "slug": "resources/api-compliance-best-practices", "title": "Bewährte Praktiken zur API-Einhaltung", "description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 104, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-readiness-checklist", "slug": "resources/automation-readiness-checklist", "title": "Checkliste zur Automatisierungsbereitschaft", "description": "Eine Checkliste zur Validierung von Automatisierungs-Workflow, Kontrollen, Risiko, Compliance, menschlicher Aufsicht, Testnachweisen, Rollback, Betrieb und Veröffentlichungsbereitschaft.", "category": "checklist", "icon": "check-box-outline", "order": 187, "outcomes": [ "Dokumentierte Automatisierungsbereitschaft", "Bekannte Bereitschaftslücken und Gegenmaßnahmen vor der Veröffentlichung", "Nachweise für Qualität, Risiko, Compliance, Aufsicht und betriebliche Freigabe" ], "steps": [ "Prüfen Sie Workflow-Design, Geschäftsregeln, Kontrollen, Zugriff, Datenverarbeitung und Ausnahmewege.", "Überprüfen Sie Testnachweise, Rollback-Verfahren, Überwachungsmodell und Supportbereitschaft.", "Bestätigen Sie Verantwortung, Runbooks, Monitoring, Änderungskontrollen und Veröffentlichungsfreigabe.", "Dokumentieren Sie ungelöste Lücken, Entscheidungen und akzeptierte Risiken vor der Veröffentlichung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "governance-specialist:facilitate-station", "governance-specialist:use-resources", "governance-specialist:next-actions" ] }, { "id": "integration-architect", "stakeholderId": "integration-architect", "title": "Integrationsarchitekt", "summary": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "stakeholder": { "id": "integration-architect", "sourceKey": "integration-architect", "sourceStakeholderId": "integration-architect", "title": "Integrationsarchitekt", "description": "Entwirft Integrationsansätze und Implementierungsstile, die die Capability oder API mit anderen Systemen verbinden.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" } ], "decisions": [ "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen." ], "outputs": [ "Validierte Architektur- und Plattformentscheidung", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit", "architecture-decision", "documentation", "platform-config", "metrics", "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise" ], "recommendedResources": [ { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true }, { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "promptIds": [ "integration-architect:facilitate-station", "integration-architect:use-resources", "integration-architect:next-actions" ] }, { "id": "customer-specialist", "stakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "summary": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "stakeholder": { "id": "customer-specialist", "sourceKey": "customer-specialist", "sourceStakeholderId": "customer-specialist", "title": "Kunden- oder Partnervertreter", "description": "Vertritt die Perspektive von Kunden oder Partnern hinsichtlich Journey, Wert und Zusammenarbeitsmodell.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "apiBusinessModelCanvas", "title": "API Business Model Canvas" } ], "decisions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "outputs": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung", "design-artifact", "documentation", "research", "roadmap", "Explizite Nutzeranforderungen und Onboarding-Erwartungen" ], "recommendedResources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiValuePropositionCanvas", "slug": "resources/api-value-proposition-canvas", "title": "API Value Proposition Canvas", "description": "Richten Sie API-Funktionen an den Bedürfnissen der Benutzer aus, indem Sie Aufgaben, Schmerzen und Gewinne auf API-Produkte abbilden.", "category": "canvas", "icon": "dashboard-outline", "order": 2, "outcomes": [ "Fokussierte Funktionsentwicklung", "Ausrichtung auf die Bedürfnisse der Nutzer", "Verbesserte Zufriedenheit der API-Kunden" ], "steps": [ "Aufgaben der Benutzerreise auflisten", "Identifizierung von Merkmalen, die erwartete Gewinne liefern", "Merkmale zur Bewältigung von Herausforderungen definieren", "Zuordnung von Merkmalen zu API-Produkten" ], "canvasId": "apiValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "apiBusinessModelCanvas", "slug": "resources/api-business-model-canvas", "title": "API Business Model Canvas", "description": "Strategische Bewertung der API-Geschäftsfähigkeit durch Zuordnung von Wertangeboten, Kundensegmenten und Schlüsselressourcen.", "category": "canvas", "icon": "dashboard-outline", "order": 3, "outcomes": [ "Klare Geschäftsstrategie für APIs", "Identifizierung der wichtigsten Ressourcen und Partner", "Abstimmung der API-Funktionen auf die Unternehmensziele" ], "steps": [ "Fassen Sie das Wertversprechen der API zusammen", "Definition von Verbrauchersegmenten", "Ermittlung von Strategien für die Beziehungen zu Entwicklern", "Karte der Vertriebskanäle", "die wichtigsten Ressourcen und Aktivitäten zu dokumentieren", "Ermittlung der wichtigsten Partner und Interessengruppen", "Nutzen und Kosten aufzeigen" ], "canvasId": "apiBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "promptIds": [ "customer-specialist:facilitate-station", "customer-specialist:use-resources", "customer-specialist:next-actions" ] }, { "id": "partner-specialist", "stakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "summary": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "stakeholder": { "id": "partner-specialist", "sourceKey": "partner-specialist", "sourceStakeholderId": "partner-specialist", "title": "Partner- und Lieferantenmanager", "description": "Koordiniert externe Partner-, Lieferanten- oder Anbieterbeziehungen, die Capability- oder API-Strategie und Umsetzung beeinflussen.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." } ], "stations": [ { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" } ], "decisions": [ "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.", "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.", "Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.", "Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen.", "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte." ], "outputs": [ "Eine auffindbare und nutzbare Capability", "Klare API-Einführungs- und Registrierungsprozesse", "Dokumentation, Sicherheitsmodelle und Richtlinien verfügbar", "APIs bereit für Skalierung und Governance", "gateway-config", "developer-portal", "documentation", "release-record" ], "recommendedResources": [ { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "service-agreement-template", "slug": "resources/service-agreement-template", "title": "Vorlage für eine Dienstleistungsvereinbarung", "description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "category": "guideline", "icon": "edit-document-outline", "order": 172, "outcomes": [ "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "partner-specialist:facilitate-station", "partner-specialist:use-resources", "partner-specialist:next-actions" ] }, { "id": "platform-architect", "stakeholderId": "platform-architect", "title": "Plattform-Architekt", "summary": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "stakeholder": { "id": "platform-architect", "sourceKey": "platform-architect", "sourceStakeholderId": "platform-architect", "title": "Plattform-Architekt", "description": "Leitet Entscheidungen zu Plattform, Integration, Skalierbarkeit und Architektur, die beeinflussen, wie die Capability oder API erstellt und betrieben wird.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "apiBusinessModelCanvas", "title": "API Business Model Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" } ], "decisions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "outputs": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung", "design-artifact", "documentation", "research", "roadmap", "Validierte Architektur- und Plattformentscheidung" ], "recommendedResources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true }, { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true } ], "promptIds": [ "platform-architect:facilitate-station", "platform-architect:use-resources", "platform-architect:next-actions" ] }, { "id": "platform-owner", "stakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "summary": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "stakeholder": { "id": "platform-owner", "sourceKey": "platform-owner", "sourceStakeholderId": "platform-owner", "title": "Plattformverantwortlicher", "description": "Verantwortet Plattform-Capabilities, Roadmap, Betriebsmodell und Serviceerwartungen.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" } ], "decisions": [ "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen." ], "outputs": [ "Validierte Architektur- und Plattformentscheidung", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit", "architecture-decision", "documentation", "platform-config", "metrics", "Eine technologieunabhängige Capability Opportunity" ], "recommendedResources": [ { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-community-engagement-strategies", "slug": "resources/api-community-engagement-strategies", "title": "Strategien für das Engagement der API-Gemeinschaft", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 103, "outcomes": [ "Besseres Verständnis der Grundsätze von Strategien zur Einbindung der API-Gemeinschaft", "Standardisierter Ansatz mit API-Strategien zur Einbindung der Gemeinschaft", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "partner-integration-guidelines", "slug": "resources/partner-integration-guidelines", "title": "Leitlinien für die Integration von Partnern", "description": "Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.", "category": "guideline", "icon": "edit-document-outline", "order": 164, "outcomes": [ "Besseres Verständnis der Grundsätze der Leitlinien für die Integration von Partnern", "Standardisierter Ansatz unter Verwendung der Richtlinien zur Partnerintegration", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Festlegung von Integrationsprozessen und Richtlinien für die Zusammenarbeit mit Partnern, einschließlich technischer Integration, Datenaustausch und Unterstützung.", "Überwachen Sie die API-Leistung und -Einhaltung der Partner, um Zuverlässigkeit und Übereinstimmung mit Ihrer API-Strategie zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "platform-owner:facilitate-station", "platform-owner:use-resources", "platform-owner:next-actions" ] }, { "id": "process-owner", "stakeholderId": "process-owner", "title": "Prozessverantwortlicher", "summary": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "stakeholder": { "id": "process-owner", "sourceKey": "process-owner", "sourceStakeholderId": "process-owner", "title": "Prozessverantwortlicher", "description": "Verantwortet den zu automatisierenden Geschäftsprozess, einschließlich Ziele, Regeln, Ergebnisse und Verbesserungsprioritäten.", "involvement": "" }, "cycles": [ { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." } ], "canvases": [ { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" } ], "decisions": [ "Analysieren Sie die Kunden- oder Partner-Journey, aus der der Capability-Bedarf entsteht, und identifizieren Sie Aufgaben, Pain Points, Gains, Inputs, Outputs und Entscheidungspunkte.", "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.", "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.", "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren Nutzer an der nächsten Station zu validieren.", "Nutzen Sie gemeinsame Journey-, Domänen-, Wertversprechen- und Geschäftsmodell-Canvases, um technologieunabhängige Anforderungen zu erfassen und zu entscheiden, ob die Capability wiederverwendbar sein sollte.", "Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden." ], "outputs": [ "Eine technologieunabhängige Capability Opportunity", "Gemeinsame Sprache zwischen Produkt, Design und Technik", "Ein solides Argument für die Finanzierung/Bewilligung", "design-artifact", "documentation", "research", "roadmap", "Explizite Nutzeranforderungen und Onboarding-Erwartungen" ], "recommendedResources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "process-workflow-design-guide", "slug": "resources/process-workflow-design-guide", "title": "Leitfaden für Prozess- und Workflow-Design", "description": "Orientierung zur Modellierung von Prozessschritten, Rollen, Übergaben, Entscheidungspunkten, Zuständen, Eingaben, Ausgaben und Ausnahmen, die einen Automatisierungs-Workflow prägen.", "category": "guideline", "icon": "edit-document-outline", "order": 181, "outcomes": [ "Klares Design des Automatisierungs-Workflows", "Prozessschritte und Übergaben vor der Implementierung dokumentiert", "Workflow-Zustände, Eingaben, Ausgaben und Ausnahmewege verstanden" ], "steps": [ "Modellieren Sie den aktuellen und den Ziel-Prozessfluss einschließlich menschlicher und systemseitiger Verantwortlichkeiten.", "Identifizieren Sie Workflow-Auslöser, Zustände, Entscheidungen, Dateneingaben, Ausgaben und Abschlusskriterien.", "Dokumentieren Sie Übergaben zwischen Nutzern, Systemen, Betrieb und Supportrollen.", "Bestätigen Sie, welche Schritte automatisiert werden sollen und welche menschliches Urteilsvermögen erfordern." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "decision-business-rules-guide", "slug": "resources/decision-business-rules-guide", "title": "Leitfaden für Entscheidungen und Geschäftsregeln", "description": "Orientierung zur Erfassung von Regeln, Schwellenwerten, Entscheidungen, Genehmigungen, Eignungsprüfungen und Regelverantwortung für das Automatisierungsdesign.", "category": "guideline", "icon": "edit-document-outline", "order": 182, "outcomes": [ "Explizite Entscheidungen und Geschäftsregeln", "Regeln und Schwellenwerte mit Verantwortlichen dokumentiert", "Automatisierungsentscheidungen auf Richtlinien, Prozesse oder Geschäftsabsicht zurückführbar" ], "steps": [ "Listen Sie Entscheidungen auf, die die Automatisierung treffen oder unterstützen muss.", "Dokumentieren Sie Regelbedingungen, Schwellenwerte, Ausnahmen, Genehmigungen und Eskalationspunkte.", "Identifizieren Sie Regelverantwortliche und Änderungsgovernance für jeden Entscheidungsbereich." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-trigger-handoff-exception-guide", "slug": "resources/automation-trigger-handoff-exception-guide", "title": "Leitfaden für Automatisierungsauslöser, Übergaben und Ausnahmen", "description": "Orientierung zur Definition von Automatisierungsauslösern, menschlichen Übergaben, Ausnahmebehandlung, Wiederholungen, Ausgleichsmaßnahmen und Support-Eskalationswegen.", "category": "guideline", "icon": "edit-document-outline", "order": 183, "outcomes": [ "Definierte Automatisierungsauslöser und Ausnahmewege", "Menschliche Übergaben und Support-Eskalationen sind explizit", "Ausnahmen, Wiederholungen und Ausgleichsmaßnahmen sind vor der Bereitstellung entworfen" ], "steps": [ "Definieren Sie Ereignisse, Zeitpläne, Nutzeraktionen oder Systemzustände, die die Automatisierung auslösen.", "Modellieren Sie Übergaben von der Automatisierung an Nutzer, Betreiber oder Supportteams.", "Dokumentieren Sie Ausnahmen, Wiederholungsregeln, Timeout-Verhalten und Rückfallwege.", "Definieren Sie Warnungen und Eskalationsschwellen für fehlgeschlagene oder uneindeutige Automatisierungsergebnisse." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-testing-guide", "slug": "resources/automation-testing-guide", "title": "Leitfaden für Automatisierungstests", "description": "Orientierung zum Testen automatisierter Workflows, Entscheidungen, Integrationen, Ausnahmen, Rollback-Verhalten, Überwachung und Nutzerauswirkungen vor der Veröffentlichung.", "category": "guideline", "icon": "edit-document-outline", "order": 184, "outcomes": [ "Validiertes Automatisierungsverhalten", "Workflow-, Regel-, Ausnahme- und Integrationstests definiert", "Veröffentlichungssicherheit für automatisierte und menschlich unterstützte Pfade" ], "steps": [ "Erstellen Sie Tests für Standardabläufe, Grenzfälle, Ausnahmen, Wiederholungen und Übergaben.", "Validieren Sie Geschäftsregeln und Entscheidungsergebnisse mit repräsentativen Daten.", "Testen Sie Rollback, Wiederherstellung, Beobachtbarkeit und manuelle Eingriffspfade.", "Beziehen Sie Nutzer und Betreiber in Abnahmetests ein, wenn die Automatisierung Arbeitsweisen verändert." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-operational-ownership-guide", "slug": "resources/automation-operational-ownership-guide", "title": "Leitfaden für die betriebliche Verantwortung von Automatisierungen", "description": "Orientierung zur Definition von Verantwortung, Runbooks, Überwachung, Support, Monitoring, Änderungskontrolle und kontinuierlicher Verbesserung für Automatisierungen.", "category": "guideline", "icon": "edit-document-outline", "order": 185, "outcomes": [ "Klares Betriebsmodell für die Automatisierung", "Verantwortlichkeiten für Eigentum, Support und Eskalation zugewiesen", "Monitoring- und Änderungspraktiken für den Live-Betrieb bereit" ], "steps": [ "Definieren Sie fachliche, technische und betriebliche Verantwortliche für die Automatisierung.", "Dokumentieren Sie Runbooks, Supportwege, Monitoring-Signale, Serviceerwartungen und Eskalationsregeln.", "Legen Sie Änderungskontrolle und Review-Praktiken für Workflow-, Plattform- und Regeländerungen fest." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "process-owner:facilitate-station", "process-owner:use-resources", "process-owner:next-actions" ] }, { "id": "security-specialist", "stakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "summary": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "stakeholder": { "id": "security-specialist", "sourceKey": "security-specialist", "sourceStakeholderId": "security-specialist", "title": "Sicherheitsspezialist", "description": "Stellt sicher, dass Sicherheitsrisiken, Kontrollen und Vertrauensgrenzen über den gesamten Lebenszyklus hinweg berücksichtigt werden.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." }, { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." } ], "canvases": [ { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "apiBusinessModelCanvas", "title": "API Business Model Canvas" } ], "decisions": [ "Nutzen Sie Business Impact, Capacity, Security und Architecture Decision Ressourcen, um Risiken, Constraints und Alternativen systematisch zu bewerten.", "Kartierung der Standorte von API-Anbietern und -Nutzern, um die Zugänglichkeit und Einhaltung von Vorschriften zu gewährleisten.", "Das Capacity Canvas gleicht geschäftliche Transaktionsmuster, künftige Verbrauchstrends und technische Lösungen ab, um die Skalierbarkeit und Leistung von APIs zu gewährleisten und liefert wichtige Informationen für Skalierungsentscheidungen und die Infrastrukturplanung.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Nutzen Sie Architektur- und Plattformressourcen, um tragfähige Umsetzungsoptionen zu vergleichen und eine nachvollziehbare Entscheidung zu treffen.", "Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen." ], "outputs": [ "Validierte Architektur- und Plattformentscheidung", "Umsetzung einer einheitlichen Governance ohne starke Kontrolle von oben nach unten", "Design für interne Wiederverwendung und externe Skalierbarkeit", "architecture-decision", "documentation", "platform-config", "metrics", "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise" ], "recommendedResources": [ { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true }, { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false } ], "promptIds": [ "security-specialist:facilitate-station", "security-specialist:use-resources", "security-specialist:next-actions" ] }, { "id": "api-devrel-specialist", "stakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "summary": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "stakeholder": { "id": "api-devrel-specialist", "sourceKey": "api-devrel-specialist", "sourceStakeholderId": "api-devrel-specialist", "title": "Verantwortlicher für Dokumentation und DevRel", "description": "Verantwortet Onboarding-Inhalte, Entwicklerkommunikation und Dokumentationsqualität für API-Nutzer.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." } ], "canvases": [ { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" } ], "decisions": [ "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab.", "Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können." ], "outputs": [ "Explizite Nutzeranforderungen und Onboarding-Erwartungen", "Definieren Sie die API-Erlebnisreise", "Onboarding, Dokumentation und Feedback planen", "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)", "design-artifact", "documentation", "consumer-feedback", "Eine auffindbare und nutzbare Capability" ], "recommendedResources": [ { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "service-agreement-template", "slug": "resources/service-agreement-template", "title": "Vorlage für eine Dienstleistungsvereinbarung", "description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "category": "guideline", "icon": "edit-document-outline", "order": 172, "outcomes": [ "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-community-engagement-strategies", "slug": "resources/api-community-engagement-strategies", "title": "Strategien für das Engagement der API-Gemeinschaft", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 103, "outcomes": [ "Besseres Verständnis der Grundsätze von Strategien zur Einbindung der API-Gemeinschaft", "Standardisierter Ansatz mit API-Strategien zur Einbindung der Gemeinschaft", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true }, { "id": "apiValuePropositionCanvas", "slug": "resources/api-value-proposition-canvas", "title": "API Value Proposition Canvas", "description": "Richten Sie API-Funktionen an den Bedürfnissen der Benutzer aus, indem Sie Aufgaben, Schmerzen und Gewinne auf API-Produkte abbilden.", "category": "canvas", "icon": "dashboard-outline", "order": 2, "outcomes": [ "Fokussierte Funktionsentwicklung", "Ausrichtung auf die Bedürfnisse der Nutzer", "Verbesserte Zufriedenheit der API-Kunden" ], "steps": [ "Aufgaben der Benutzerreise auflisten", "Identifizierung von Merkmalen, die erwartete Gewinne liefern", "Merkmale zur Bewältigung von Herausforderungen definieren", "Zuordnung von Merkmalen zu API-Produkten" ], "canvasId": "apiValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "promptIds": [ "api-devrel-specialist:facilitate-station", "api-devrel-specialist:use-resources", "api-devrel-specialist:next-actions" ] }, { "id": "operations-specialist", "stakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "summary": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "stakeholder": { "id": "operations-specialist", "sourceKey": "operations-specialist", "sourceStakeholderId": "operations-specialist", "title": "Verantwortlicher für Support und Betrieb", "description": "Repräsentiert Runtime-Support, Vorfallbehandlung, Beobachtbarkeit und operative Bereitschaft für Capability, API oder Automatisierung.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-delivery", "title": "Bereitstellung & Betrieb", "description": "Setzen Sie die gewählte Umsetzungsweise mit geeigneten Engineering-, Test-, Sicherheits-, Automatisierungs- und Betriebspraktiken um." }, { "id": "api-audit", "title": "Qualitäts- & Bereitschaftssicherung", "description": "Prüfen Sie Schnittstellenvertrag, Kontrollen, Supportmodell, Observability, Dokumentation und Lifecycle-Bereitschaft vor der Veröffentlichung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." } ], "canvases": [ { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" } ], "decisions": [ "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab.", "Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen." ], "outputs": [ "Explizite Nutzeranforderungen und Onboarding-Erwartungen", "Definieren Sie die API-Erlebnisreise", "Onboarding, Dokumentation und Feedback planen", "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)", "design-artifact", "documentation", "consumer-feedback", "Eine bereitgestellte Capability, die mit dem validierten Schnittstellenvertrag übereinstimmt" ], "recommendedResources": [ { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false }, { "id": "api-compliance-best-practices", "slug": "resources/api-compliance-best-practices", "title": "Bewährte Praktiken zur API-Einhaltung", "description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 104, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "service-agreement-template", "slug": "resources/service-agreement-template", "title": "Vorlage für eine Dienstleistungsvereinbarung", "description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "category": "guideline", "icon": "edit-document-outline", "order": 172, "outcomes": [ "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-community-engagement-strategies", "slug": "resources/api-community-engagement-strategies", "title": "Strategien für das Engagement der API-Gemeinschaft", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 103, "outcomes": [ "Besseres Verständnis der Grundsätze von Strategien zur Einbindung der API-Gemeinschaft", "Standardisierter Ansatz mit API-Strategien zur Einbindung der Gemeinschaft", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "promptIds": [ "operations-specialist:facilitate-station", "operations-specialist:use-resources", "operations-specialist:next-actions" ] }, { "id": "api-consumer-specialist", "stakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "summary": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "stakeholder": { "id": "api-consumer-specialist", "sourceKey": "api-consumer-specialist", "sourceStakeholderId": "api-consumer-specialist", "title": "Vertreter der API-Nutzer", "description": "Vertritt die Anforderungen von Entwicklern, Integratoren und anderen Nutzern der API.", "involvement": "" }, "cycles": [ { "id": "capability-productization-cycle", "title": "Capability-Produktisierungszyklus", "description": "Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird." }, { "id": "api-productization-cycle", "title": "API-Produktisierungszyklus", "description": "Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs." }, { "id": "integration-productization-cycle", "title": "Integrationszyklus", "description": "Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird." }, { "id": "automation-cycle", "title": "Automatisierungszyklus", "description": "Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten." } ], "stations": [ { "id": "api-consumer-experience", "title": "Nutzeranforderungen & Onboarding", "description": "Erfassen Sie Nutzeranforderungen, Onboarding, Standards, nicht-funktionale Anforderungen, Serviceerwartungen, Einschränkungen, Sicherheitsbedarf, Protokolle, Datenaktualität, SLAs, Observability, Wiederherstellung, Adoption und Verantwortlichkeiten der Anbieter." }, { "id": "api-design", "title": "Lösungs- & Schnittstellendesign", "description": "Entwerfen Sie die gewählte Umsetzungsweise, den Schnittstellenvertrag, Interaktionsmuster, Datenstrukturen und Nutzungsdetails vor der Implementierung." }, { "id": "api-publishing", "title": "Veröffentlichung & Enablement", "description": "Veröffentlichen Sie Capability-Informationen so, dass Nutzer sie finden, bewerten, Zugriff beantragen, onboarden, nutzen und Support erhalten können." }, { "id": "monitoring-and-improving", "title": "Monitoring & Verbesserung", "description": "Überwachen Sie Nutzung, Zuverlässigkeit, Datenqualität, Nutzerergebnisse, Betriebskosten und Wiederverwendungsmöglichkeiten nach der Veröffentlichung." }, { "id": "api-product-strategy", "title": "Strategie", "description": "Beschreiben Sie den Geschäftsbedarf als wiederverwendbare Capability, bevor Sie die Umsetzungsweise festlegen." }, { "id": "api-platform-architecture", "title": "Architektur & Plattformentscheidungen", "description": "Nutzen Sie Anforderungen und Einschränkungen, um Architektur, Plattformfähigkeiten, Governance und Betriebsmodell zu wählen." } ], "canvases": [ { "id": "consumerExperienceRequirementsCanvas", "title": "Consumer Experience Requirements Canvas" }, { "id": "domainCanvas", "title": "Domain Canvas" }, { "id": "interactionCanvas", "title": "Interaction Canvas" }, { "id": "customerJourneyCanvas", "title": "Customer Journey Canvas" }, { "id": "capabilityValuePropositionCanvas", "title": "Capability Value Proposition Canvas" }, { "id": "capabilityBusinessModelCanvas", "title": "Capability Business Model Canvas" }, { "id": "businessImpactCanvas", "title": "Business Impact Canvas" }, { "id": "locationsCanvas", "title": "Locations Canvas" }, { "id": "capacityCanvas", "title": "Capacity Canvas" }, { "id": "apiValuePropositionCanvas", "title": "API Value Proposition Canvas" }, { "id": "restCanvas", "title": "REST Canvas" }, { "id": "eventCanvas", "title": "Event Canvas" }, { "id": "graphqlCanvas", "title": "GraphQL Canvas" }, { "id": "apiBusinessModelCanvas", "title": "API Business Model Canvas" } ], "decisions": [ "Nutzen Sie das Consumer Experience Requirements Canvas, um Nutzerziele, Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität, Sicherheit, Onboarding, Änderungen, Observability und Wiederherstellungserwartungen festzuhalten.", "Verwenden Sie das Customer Journey Canvas für die Customer Journey des Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den Nutzer zu verbessern.", "Nutzen Sie Consumer-Experience- und Onboarding-Guidance, um Erwartungen für Nutzer und Anbieter explizit zu machen.", "Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab.", "Prüfen Sie Domänenobjekte, Begriffe, Regeln und Ownership, bevor Sie den Schnittstellenvertrag entwerfen." ], "outputs": [ "Explizite Nutzeranforderungen und Onboarding-Erwartungen", "Definieren Sie die API-Erlebnisreise", "Onboarding, Dokumentation und Feedback planen", "Verbesserung der Akzeptanz durch echte Empathie + Developer Experience (DX)", "design-artifact", "documentation", "consumer-feedback", "Ein validierter Schnittstellenvertrag für die gewählte Umsetzungsweise" ], "recommendedResources": [ { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true }, { "id": "service-agreement-template", "slug": "resources/service-agreement-template", "title": "Vorlage für eine Dienstleistungsvereinbarung", "description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "category": "guideline", "icon": "edit-document-outline", "order": 172, "outcomes": [ "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-community-engagement-strategies", "slug": "resources/api-community-engagement-strategies", "title": "Strategien für das Engagement der API-Gemeinschaft", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 103, "outcomes": [ "Besseres Verständnis der Grundsätze von Strategien zur Einbindung der API-Gemeinschaft", "Standardisierter Ansatz mit API-Strategien zur Einbindung der Gemeinschaft", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false } ], "promptIds": [ "api-consumer-specialist:facilitate-station", "api-consumer-specialist:use-resources", "api-consumer-specialist:next-actions" ] } ], "resources": [ { "id": "customerJourneyCanvas", "slug": "resources/customer-journey-canvas", "title": "Customer Journey Canvas", "description": "Zeichnen Sie die Customer Journeys auf, um Bedürfnisse und Schmerzpunkte zu identifizieren und so das API-Design und die Benutzererfahrung zu verbessern.", "category": "canvas", "icon": "dashboard-outline", "order": 1, "outcomes": [ "Verbessertes Kundenverständnis", "Verbessertes API-Design", "Bessere Nutzererfahrung" ], "steps": [ "Kunden-Persona definieren", "Identifizieren Sie Auslöser für die Reise", "Beschreiben Sie das Ende der Reise", "Abbildung von Fahrtschritten mit Ein- und Ausgängen", "Kundenbedürfnisse identifizieren", "Kundengewinne zusammenfassen", "Definition der erforderlichen Inputs und der daraus resultierenden Outputs", "Definieren Sie API-Interaktionen für jeden Schritt" ], "canvasId": "customerJourneyCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "apiValuePropositionCanvas", "slug": "resources/api-value-proposition-canvas", "title": "API Value Proposition Canvas", "description": "Richten Sie API-Funktionen an den Bedürfnissen der Benutzer aus, indem Sie Aufgaben, Schmerzen und Gewinne auf API-Produkte abbilden.", "category": "canvas", "icon": "dashboard-outline", "order": 2, "outcomes": [ "Fokussierte Funktionsentwicklung", "Ausrichtung auf die Bedürfnisse der Nutzer", "Verbesserte Zufriedenheit der API-Kunden" ], "steps": [ "Aufgaben der Benutzerreise auflisten", "Identifizierung von Merkmalen, die erwartete Gewinne liefern", "Merkmale zur Bewältigung von Herausforderungen definieren", "Zuordnung von Merkmalen zu API-Produkten" ], "canvasId": "apiValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityValuePropositionCanvas", "slug": "resources/capability-value-proposition-canvas", "title": "Capability Value Proposition Canvas", "description": "Ein technologieunabhängiges Canvas zur Zuordnung von Nutzeraufgaben, Gewinnen, Problemen und möglichen wiederverwendbaren Capabilities, bevor ein Implementierungsstil ausgewählt wird.", "category": "canvas", "icon": "dashboard-outline", "order": 2.1, "outcomes": [ "Klare Wertpositionierung der wiederverwendbaren Capability", "Nutzeraufgaben, Gewinne und Probleme ohne technologische Vorannahme erfasst", "Mögliche wiederverwendbare Capabilities für die Architekturbewertung identifiziert" ], "steps": [ "Listen Sie die Nutzeraufgaben und Ergebnisse auf, die die Capability unterstützen soll.", "Identifizieren Sie Capability-Merkmale, die Gewinne ermöglichen.", "Identifizieren Sie Capability-Merkmale, die Probleme reduzieren.", "Gruppieren Sie die Merkmale zu möglichen wiederverwendbaren Capabilities." ], "canvasId": "capabilityValuePropositionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "apiBusinessModelCanvas", "slug": "resources/api-business-model-canvas", "title": "API Business Model Canvas", "description": "Strategische Bewertung der API-Geschäftsfähigkeit durch Zuordnung von Wertangeboten, Kundensegmenten und Schlüsselressourcen.", "category": "canvas", "icon": "dashboard-outline", "order": 3, "outcomes": [ "Klare Geschäftsstrategie für APIs", "Identifizierung der wichtigsten Ressourcen und Partner", "Abstimmung der API-Funktionen auf die Unternehmensziele" ], "steps": [ "Fassen Sie das Wertversprechen der API zusammen", "Definition von Verbrauchersegmenten", "Ermittlung von Strategien für die Beziehungen zu Entwicklern", "Karte der Vertriebskanäle", "die wichtigsten Ressourcen und Aktivitäten zu dokumentieren", "Ermittlung der wichtigsten Partner und Interessengruppen", "Nutzen und Kosten aufzeigen" ], "canvasId": "apiBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capabilityBusinessModelCanvas", "slug": "resources/capability-business-model-canvas", "title": "Capability Business Model Canvas", "description": "Ein Business Model Canvas für wiederverwendbare Integrations-Capabilities, das Wert, Nutzer, Verantwortung, Einbindung, Kosten und Nutzen abdeckt, ohne API-Bereitstellung vorauszusetzen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.1, "outcomes": [ "Tragfähiges Betriebsmodell für die wiederverwendbare Capability", "Verantwortung, Nutzer, Kanäle, Partner und Supportbedarf geklärt", "Kosten und Nutzen vor der Architekturfestlegung sichtbar" ], "steps": [ "Fassen Sie die Wertpositionierung der Capability zusammen.", "Identifizieren Sie Nutzersegmente und Einbindungskanäle.", "Definieren Sie Schlüsselaktivitäten, Ressourcen und Partner.", "Erfassen Sie Kosten und Nutzen.", "Klären Sie Verantwortung, Finanzierung, Support und Lifecycle-Erwartungen.", "Validieren Sie das Modell mit Nutzern, Produzenten und Governance-Stakeholdern." ], "canvasId": "capabilityBusinessModelCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "consumerExperienceRequirementsCanvas", "slug": "resources/consumer-experience-requirements-canvas", "title": "Consumer Experience Requirements Canvas", "description": "Ein Anforderungen-Canvas für nutzerbezogene Experience- und nichtfunktionale Anforderungen, die die spätere Architekturentscheidung steuern sollen.", "category": "canvas", "icon": "dashboard-outline", "order": 3.2, "outcomes": [ "Technologieunabhängige Nutzeranforderungen", "Experience- und nichtfunktionale Anforderungen vor Designbeginn erfasst", "Architekturauswirkungen für die Stilauswahl dokumentiert" ], "steps": [ "Erfassen Sie Nutzerziele und Nutzungskontext.", "Dokumentieren Sie Erwartungen an Verfügbarkeit, Aktualität, Volumen, Performance, Datenqualität und Konsistenz.", "Dokumentieren Sie Erwartungen an Sicherheit, Datenschutz, Onboarding, Änderung, Beobachtbarkeit, Support und Wiederherstellung.", "Fassen Sie zusammen, was die Anforderungen für mögliche Architekturstile bedeuten." ], "canvasId": "consumerExperienceRequirementsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "businessImpactCanvas", "slug": "resources/business-impact-canvas", "title": "Business Impact Canvas", "description": "Entwurf einer skalierbaren und sicheren API-Plattformarchitektur, die den geschäftlichen und technischen Anforderungen entspricht.", "category": "canvas", "icon": "dashboard-outline", "order": 4, "outcomes": [ "Skalierbare API-Infrastruktur", "Verbesserte Sicherheit und Konformität", "Verbesserte API-Leistung" ], "steps": [ "Verfügbarkeits-Risiken: Identifizieren Sie Risiken und Auswirkungen.", "Möglichkeiten zur Abschwächung von Verfügbarkeitsrisiken: Definieren Sie Abhilfemaßnahmen.", "Sicherheits-Risiken: Dokumentieren Sie sicherheitsrelevante Risiken.", "Wege zur Abschwächung von Sicherheitsrisiken: Vorschlagen von Strategien zur Abschwächung von Sicherheitsrisiken.", "Daten-Risiken: Identifizieren Sie Risiken für die Genauigkeit oder Verfügbarkeit von Daten.", "Wege zur Abschwächung von Datenrisiken: Planen Sie Strategien für den Umgang mit Datenrisiken." ], "canvasId": "businessImpactCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "locationsCanvas", "slug": "resources/location-canvas", "title": "Location Canvas", "description": "Kartieren Sie die Standorte von API-Anbietern und -Verbrauchern, um die Einhaltung von Vorschriften und die Leistung in verschiedenen Regionen sicherzustellen.", "category": "canvas", "icon": "dashboard-outline", "order": 6, "outcomes": [ "Einhaltung der örtlichen Vorschriften", "Optimierte API-Leistung über Regionen hinweg", "Verbessertes Verständnis der regionalen Anforderungen" ], "steps": [ "Karte der Standorte von API-Anbietern.", "Dokumentieren Sie, wo sich die Verbraucher befinden.", "Ermitteln Sie die geltenden Vorschriften.", "Dokumentieren Sie, wo die Daten gespeichert werden müssen.", "Sicherstellen, dass die APIs in allen vorgesehenen Netzregionen zugänglich sind.", "Validierung der Netzwerkleistung in verschiedenen Regionen." ], "canvasId": "locationsCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "capacityCanvas", "slug": "resources/capacity-canvas", "title": "Capacity Canvas", "description": "Planen Sie die API-Kapazität, um den aktuellen und zukünftigen Geschäftsanforderungen gerecht zu werden, und gewährleisten Sie Skalierbarkeit und Leistung.", "category": "canvas", "icon": "dashboard-outline", "order": 7, "outcomes": [ "Anpassung der API-Kapazität an das Geschäftsvolumen", "Vorbereitet auf zukünftige Konsumtrends", "Definierte Caching- und Ratenbegrenzungsstrategien" ], "steps": [ "Dokumentieren Sie das aktuelle Geschäftsvolumen", "Vorhersage künftiger Verbrauchstrends", "Planen Sie für Lastspitzen und Verfügbarkeitsanforderungen", "Caching und Strategien zur Ratenbegrenzung definieren", "Skalierungsstrategien vorschlagen" ], "canvasId": "capacityCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "interactionCanvas", "slug": "resources/interaction-canvas", "title": "Interaction Canvas", "description": "Definieren Sie API-Interaktionen, Arbeitsabläufe und erwartete Antworten, um ein einheitliches API-Erlebnis zu gewährleisten.", "category": "canvas", "icon": "dashboard-outline", "order": 9, "outcomes": [ "Klare API-Interaktionsabläufe", "Definierte Inputs und Outputs für jede Interaktion", "Konsistente Validierungsregeln für alle Interaktionen" ], "steps": [ "Zuordnung von API-Interaktionen zu Benutzeraufgaben", "Definieren Sie Endpunkte für jede Interaktion", "Inputs und Outputs für jede Interaktion zu dokumentieren", "Angabe von Validierungsregeln und -beschränkungen", "Erstellen von Interaktionsmodellen für CRUD-, abfrage-, befehlsgesteuerte und ereignisgesteuerte Interaktionen" ], "canvasId": "interactionCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "restCanvas", "slug": "resources/rest-canvas", "title": "REST Canvas", "description": "Entwurf von APIs unter Verwendung von RESTful-Prinzipien, Definition von Ressourcen, Verben und Beispielanforderungen und -antworten.", "category": "canvas", "icon": "dashboard-outline", "order": 10, "outcomes": [ "Einheitliches RESTful API-Design", "Definierte Ressourcen und ihre Interaktionen", "Beispielhafte Anfragen und Antworten zur Verdeutlichung" ], "steps": [ "Identifizierung der wichtigsten Ressourcen, die von der API bereitgestellt werden", "Definieren Sie die Struktur des API-Ressourcenmodells", "Angabe von HTTP-Verben für die Interaktion mit Ressourcen", "Geben Sie Beispiele für Anfragen und Antworten für jedes Verb an." ], "canvasId": "restCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "graphqlCanvas", "slug": "resources/graphql-canvas", "title": "GraphQL Canvas", "description": "Entwerfen Sie GraphQL-APIs, indem Sie Typen, Abfragen, Mutationen und Abonnements definieren.", "category": "canvas", "icon": "dashboard-outline", "order": 11, "outcomes": [ "Strukturierter GraphQL-API-Entwurf", "Definierte Typen und ihre Beziehungen", "Abfragen, Mutationen und Abonnements löschen" ], "steps": [ "Welche Probleme versuchen die API-Kunden zu lösen? Welche Daten benötigen sie?", "Definieren Sie GraphQL-Typen und ihre Attribute: Was sind die wichtigsten Typen (z. B. Benutzer, Bestellung, Produkt)?", "Beziehungen zwischen Typen abbilden: Wie stehen die Typen in verschachtelten Abfragen zueinander?", "Abfragen für den Datenabruf spezifizieren", "Definieren Sie Mutationen für Datenänderungen: Durch welche Operationen werden Daten verändert (z. B. Erstellen, Aktualisieren, Löschen)?", "Übersichtsabonnements für Echtzeit-Updates", "Definieren Sie Authentifizierung und Autorisierung: Wer darf auf welche Felder oder Typen zugreifen?", "Überlegen Sie, ob es Einschränkungen in Bezug auf Paginierung, Filterung oder Ratenbegrenzung gibt." ], "canvasId": "graphqlCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "eventCanvas", "slug": "resources/event-canvas", "title": "Event Canvas", "description": "Entwerfen Sie ereignisgesteuerte APIs, indem Sie Ereignisse, Auslöser und Verarbeitungslogik definieren.", "category": "canvas", "icon": "dashboard-outline", "order": 12, "outcomes": [ "Definierte ereignisgesteuerte Architektur", "Ereignisauslöser und Verarbeitungslogik löschen", "Verbesserte Reaktionsfähigkeit auf Änderungen in Echtzeit" ], "steps": [ "Identifizierung von Schlüsselereignissen im System", "Definieren Sie Auslöser für jedes Ereignis", "Beschreiben Sie die Backend-Verarbeitungslogik für Ereignisse", "Angabe der resultierenden Ausgaben oder Bestätigungen" ], "canvasId": "eventCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "api-audit-checklist", "slug": "resources/api-audit-checklist", "title": "API Audit Checkliste", "description": "Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.", "category": "checklist", "icon": "check-box-outline", "order": 13, "outcomes": [ "Besseres Verständnis der Grundsätze der API Audit Checkliste", "Standardisierter Ansatz mit API Audit Checkliste", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.", "Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.", "Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind." ], "canvasId": null, "sourcePath": "src/snippets/api-audit-checklist.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"profiles\": {\r\n \"read-only\": {\r\n \"description\": \"API profile that is read-only and does not allow create, update, or delete operations.\"\r\n },\r\n \"full-crud\": {\r\n \"description\": \"General API profile that allows create, update, and delete operations.\"\r\n }\r\n },\r\n \"lifecycleStages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6\r\n }\r\n ],\r\n \"stages\": [\r\n {\r\n \"id\": \"strategy\",\r\n \"title\": \"Strategy\",\r\n \"readinessLabel\": \"Strategy is Ready When...\",\r\n \"order\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"based-on-clear-business-needs\",\r\n \"label\": \"API is based on clear business needs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiBusinessModelCanvas\",\r\n \"apiValuePropositionCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"design-artifact\",\r\n \"documentation\",\r\n \"research\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\",\r\n \"specs/canvases/api-product-strategy/apiBusinessModelCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"concept-items-audited\",\r\n \"label\": \"All concept checklist items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"strategy\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"strategy\",\r\n \"producedByStation\": [\r\n \"api-product-strategy\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"business-goals-defined\",\r\n \"market-research-done\",\r\n \"stakeholder-approval\",\r\n \"metrics-feedback-available\",\r\n \"api-opportunity-documented\",\r\n \"api-reusability\",\r\n \"value-prop-validated\",\r\n \"consumer-segments-identified\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/concept-review-report.json\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"architecture\",\r\n \"title\": \"Architecture\",\r\n \"readinessLabel\": \"Architecture is Ready When...\",\r\n \"order\": 2,\r\n \"items\": [\r\n {\r\n \"id\": \"versioning-decided\",\r\n \"label\": \"Versioning strategy decided and supported by gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VERSION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-versioning-best-practices\",\r\n \"apiops-CI-CD-for-apis\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"ci-cd\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"only-via-gateway\",\r\n \"label\": \"Only accessible via API gateway\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-reusability\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-02\",\r\n \"REST-CAPACITY-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"businessImpactCanvas\",\r\n \"locationsCanvas\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"infra-config\",\r\n \"security-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/architecture/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"rate-limits-enforced\",\r\n \"label\": \"Rate limits are enforced\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"architecture\",\r\n \"producedByStation\": [\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-roadmap-defined\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CAPACITY-01\",\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"capacityCanvas\",\r\n \"api-security-best-practices\",\r\n \"scalable-infrastructure-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"runtime\",\r\n \"monitoring\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-platform-architecture/capacityCanvas.empty.json\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"design\",\r\n \"title\": \"Design\",\r\n \"readinessLabel\": \"Design is Ready When...\",\r\n \"order\": 3,\r\n \"items\": [\r\n {\r\n \"id\": \"endpoint-descriptions-present\",\r\n \"label\": \"Endpoints have business value and feature descriptions\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"operationDescriptions\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\",\r\n \"api-opportunity-documented\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiValuePropositionCanvas\",\r\n \"customerJourneyCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"specs/canvases/api-product-strategy/apiValuePropositionCanvas.empty.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"hides-raw-backend-data\",\r\n \"label\": \"API hides raw backend data and is designed for shared use\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"interactionCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-product-strategy/domainCanvas.empty.json\",\r\n \"specs/canvases/api-design/interactionCanvas.empty.json\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"design-consistent\",\r\n \"label\": \"API design is consistent with other APIs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-platform-architecture\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-reusability\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DOMAIN-02\",\r\n \"REST-CX-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"design-artifact\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/canvases/api-design/restCanvas.empty.json\",\r\n \"docs/api/design/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"descriptive-english-naming\",\r\n \"label\": \"Data and attribute naming uses descriptive English\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"fieldNamesDescriptive\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"mandatory-fields-specified\",\r\n \"label\": \"Mandatory fields are specified\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"requiredFieldsPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"dates-use-iso\",\r\n \"label\": \"Dates use ISO format with timezone\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"dateFormatTimezone\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"general-data-uses-standard-values\",\r\n \"label\": \"General data uses standard values\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"standardizedEnumsOrPatterns\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-DATA-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"field-names-avoid-acronyms\",\r\n \"label\": \"Field names avoid acronyms and use full words\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"avoidAcronyms\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-NAMING-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"create-returns-identifiers\",\r\n \"label\": \"Creating new resources returns identifiers\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is read-only and does not create resources.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"paths-max-two-resources\",\r\n \"label\": \"Endpoint paths contain max two resources or sub-resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"pathDepthMax\",\r\n \"maxDepth\": 2\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PATH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"examples-present\",\r\n \"label\": \"Endpoints and attributes include examples\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CX-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-for-create-update\",\r\n \"label\": \"POST is used for create or update\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose create or update operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"design-reflects-business-value\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-for-remove\",\r\n \"label\": \"DELETE is used to remove resources\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose delete operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-no-request-body\",\r\n \"label\": \"GET has no request body and returns content\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"getNoRequestBody\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"get-empty-returns-204\",\r\n \"label\": \"GET returns 204 if response body is empty\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current contract returns content for all GET operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-200\",\r\n \"label\": \"POST returns 200 OK when updating\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST updates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-200-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"post-returns-201\",\r\n \"label\": \"POST returns 201 Created with ID on create\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose POST creates.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-201-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"delete-returns-204\",\r\n \"label\": \"DELETE returns 204 on success\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"Read-only profile does not expose DELETE operations.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-RESP-204-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-onboarding-best-practices\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"400-errors-specific\",\r\n \"label\": \"400 errors provide specific error information\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"errorResponsesSpecific\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-consumer-experience\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"design-reflects-business-value\",\r\n \"api-consistency\",\r\n \"value-prop-validated\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-400-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"restCanvas\",\r\n \"api-audit-checklist\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"401-unauthorized\",\r\n \"label\": \"401 Unauthorized for wrong credentials\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current public storefront contract is intentionally unauthenticated.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-401-01\",\r\n \"REST-SEC-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"403-forbidden\",\r\n \"label\": \"403 Forbidden for unauthorized operations\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"The current profile is public read-only and exposes no unauthorized operations.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-ERROR-403-01\",\r\n \"REST-SEC-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-contains-schemas\",\r\n \"label\": \"Spec contains request and response schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"schemasPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"restCanvas\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"contract\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"pseudo-identifiers\",\r\n \"label\": \"UUIDs or pseudo-identifiers instead of DB IDs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"opaqueIdentifiers\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-07\"\r\n ],\r\n \"resourceSource\": [\r\n \"domainCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"no-sensitive-data-in-urls\",\r\n \"label\": \"No sensitive data in URLs\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"noSensitiveDataInPaths\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"hide-backend-discrepancies\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-06\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"contract-first-design\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"http-methods-match-resources\",\r\n \"label\": \"HTTP methods only for intended resources\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"methodResourceConsistency\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"design\",\r\n \"producedByStation\": [\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-HTTP-GET-01\",\r\n \"REST-HTTP-POST-01\",\r\n \"REST-HTTP-PUT-01\",\r\n \"REST-HTTP-DELETE-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"restCanvas\",\r\n \"api-design-principles\",\r\n \"contract-first-design\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"delivery\",\r\n \"title\": \"Delivery\",\r\n \"readinessLabel\": \"Delivery is Ready When...\",\r\n \"order\": 4,\r\n \"items\": [\r\n {\r\n \"id\": \"design-items-audited\",\r\n \"label\": \"All prototype and design items are audited\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"aggregate\",\r\n \"check\": {\r\n \"type\": \"stageCoverage\",\r\n \"stageId\": \"design\"\r\n },\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-design\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"design-reflects-business-value\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"report\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"audit/production-readiness-review.json\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-validated-on-change\",\r\n \"label\": \"Spec validated on every change\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"validationWorkflowPresent\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-audit-checklist\",\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"schema-and-examples-pass\",\r\n \"label\": \"Schema and examples pass validation\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"openapi\",\r\n \"check\": {\r\n \"type\": \"examplesPassValidation\"\r\n },\r\n \"automationLevel\": \"auto\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-design\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-consistency\",\r\n \"architecture-patterns-validated\",\r\n \"api-contract-tested\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-AUDIT-01\",\r\n \"REST-CONTRACT-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"api-audit-checklist\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"test\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"uses-https\",\r\n \"label\": \"Uses HTTPS or encrypted protocols\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"auth-protection\",\r\n \"label\": \"Endpoints protected by authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"gateway-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"token-auth\",\r\n \"label\": \"Token-based authentication\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"csrf-protection\",\r\n \"label\": \"Protected against CSRF\",\r\n \"applicableTo\": [\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"This profile is intentionally public read-only.\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-08\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-development-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"inputs-auto-validated\",\r\n \"label\": \"Inputs auto-validated by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-VALIDATION-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"contract-first-design\",\r\n \"api-testing-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\",\r\n \"test\",\r\n \"spec\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"outputs-auto-escaped\",\r\n \"label\": \"Outputs auto-escaped by framework\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"n/a\",\r\n \"defaultStatus\": \"na\",\r\n \"reason\": \"JSON APIs do not typically require output escaping in the same way as HTML rendering.\",\r\n \"automationLevel\": \"manual\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-development-best-practices\",\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"code\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"encryption-in-transit\",\r\n \"label\": \"Encryption for data in transit and storage\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\",\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-SEC-05\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"data-privacy-guidelines\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"infra-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"message-integrity\",\r\n \"label\": \"Message integrity implemented\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"delivery\",\r\n \"producedByStation\": [\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"architecture-patterns-validated\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-OBS-01\",\r\n \"REST-SEC-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-security-best-practices\",\r\n \"api-compliance-best-practices\",\r\n \"api-metrics-and-analytics\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"security-config\",\r\n \"monitoring\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/delivery/README.md\",\r\n \"docs/api/architecture/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"publishing\",\r\n \"title\": \"Publishing\",\r\n \"readinessLabel\": \"Publishing is Ready When...\",\r\n \"order\": 5,\r\n \"items\": [\r\n {\r\n \"id\": \"published-via-api-management\",\r\n \"label\": \"Published via API management\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-01\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"gateway-config\",\r\n \"ci-cd\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"visible-in-dev-portal\",\r\n \"label\": \"Visible in developer portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-community-engagement-strategies\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"docs-auto-generated\",\r\n \"label\": \"Docs auto-generated from spec and schema\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"partial\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-documentation-ready\",\r\n \"api-ready-for-publishing\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\",\r\n \"REST-PUBLISH-03\"\r\n ],\r\n \"resourceSource\": [\r\n \"contract-first-design\",\r\n \"apiops-CI-CD-for-apis\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"spec\",\r\n \"documentation\",\r\n \"ci-cd\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"specs/openapi/api.yaml\",\r\n \"docs/api/publishing/README.md\",\r\n \"docs/api/audit/design-audit.read-only.md\"\r\n ]\r\n },\r\n {\r\n \"id\": \"spec-auto-updated\",\r\n \"label\": \"Spec auto-updated to gateway and dev portal\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\",\r\n \"api-delivery\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\",\r\n \"api-consistency\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-CONTRACT-02\"\r\n ],\r\n \"resourceSource\": [\r\n \"apiops-CI-CD-for-apis\",\r\n \"contract-first-design\",\r\n \"api-onboarding-best-practices\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"ci-cd\",\r\n \"gateway-config\",\r\n \"documentation\"\r\n ],\r\n \"expectedEvidence\": [\r\n \".github/workflows/openapi-lint.yml\",\r\n \"docs/api/publishing/README.md\",\r\n \"specs/openapi/api.yaml\"\r\n ]\r\n },\r\n {\r\n \"id\": \"official-domain\",\r\n \"label\": \"Published under official organization domain\",\r\n \"applicableTo\": [\r\n \"read-only\",\r\n \"full-crud\"\r\n ],\r\n \"kind\": \"manual\",\r\n \"defaultStatus\": \"gap\",\r\n \"automationLevel\": \"semi\",\r\n \"primaryStage\": \"publishing\",\r\n \"producedByStation\": [\r\n \"api-publishing\"\r\n ],\r\n \"producedByStationCriteria\": [\r\n \"api-ready-for-publishing\",\r\n \"audit-passed\"\r\n ],\r\n \"guidelines\": [\r\n \"REST-PUBLISH-04\"\r\n ],\r\n \"resourceSource\": [\r\n \"api-onboarding-best-practices\",\r\n \"api-audit-checklist\"\r\n ],\r\n \"expectedEvidenceTags\": [\r\n \"documentation\",\r\n \"runtime\"\r\n ],\r\n \"expectedEvidence\": [\r\n \"docs/api/publishing/README.md\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": \"improving\",\r\n \"title\": \"Improving\",\r\n \"readinessLabel\": \"Improving is Ready When...\",\r\n \"order\": 6,\r\n \"items\": []\r\n }\r\n ],\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"based-on-clear-business-needs\",\r\n \"hides-raw-backend-data\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}\r\n", "draft": false }, { "id": "api-design-principles", "slug": "resources/api-design-principles", "title": "API Design Prinzipien", "description": "Ein prägnanter Leitfaden zu API-Benutzerfreundlichkeit, Auffindbarkeit und Konsistenz, der auf gemeinsamen Designregeln und echten Kundenbedürfnissen basiert.", "category": "guideline", "icon": "edit-document-outline", "order": 14, "outcomes": [ "Besseres Verständnis der API-Gestaltungsgrundsätze", "Standardisierter Ansatz mit API Design Prinzipien", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "**Consumer-first design:** Wir beginnen jeden APIOps-Zyklus mit der Erfassung von Benutzerzielen und Fachbegriffen, damit APIs echte Probleme lösen.", "**Konsistente Benennung und Verhalten:** Anwendung gemeinsamer Konventionen für Ressourcen, Fehler und Formate, um APIs vorhersehbar zu machen.", "**Vertragsgesteuert:** Erfassen Sie die Schnittstelle mit OpenAPI oder AsyncAPI vor der Codierung, um die Teams aufeinander abzustimmen und Automatisierung zu ermöglichen.", "**Benutzerfreundlichkeit und Auffindbarkeit:** Bereitstellung einer klaren Dokumentation und von Beispielen, damit Entwickler schnell verstehen, wie die API zu verwenden ist.", "**Sicher iterieren:** Entwürfe in kleinen, abgestuften Schritten weiterentwickeln, damit Änderungen die bestehenden Kunden nicht stören." ], "canvasId": null, "sourcePath": "src/snippets/api-style-guide.json", "sourceUrl": null, "contentMarkdown": "{\r\n \"guidelines\": [\r\n {\r\n \"id\": \"REST-CONTRACT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST implement endpoints, parameters, request bodies, response bodies, and error responses as defined in the validated OpenAPI contract.\",\r\n \"relatedAuditItems\": [\r\n \"spec-contains-schemas\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CONTRACT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST keep the implementation, published OpenAPI description, gateway configuration, and developer portal documentation aligned on every change.\",\r\n \"relatedAuditItems\": [\r\n \"docs-auto-generated\",\r\n \"spec-auto-updated\",\r\n \"spec-validated-on-change\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VALIDATION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate path parameters, query parameters, headers, and JSON request bodies against the OpenAPI schema before business processing.\",\r\n \"relatedAuditItems\": [\r\n \"mandatory-fields-specified\",\r\n \"400-errors-specific\",\r\n \"inputs-auto-validated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST expose business-oriented resources and attributes rather than raw backend tables, internal service payloads, or system-specific field names.\",\r\n \"relatedAuditItems\": [\r\n \"hides-raw-backend-data\",\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DOMAIN-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST preserve validated meanings of entities, attributes, statuses, and source-of-truth rules across all endpoints and operations.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\",\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use descriptive English names for resources and attributes.\",\r\n \"relatedAuditItems\": [\r\n \"descriptive-english-naming\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-NAMING-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST avoid unexplained acronyms in public field and resource names.\",\r\n \"relatedAuditItems\": [\r\n \"field-names-avoid-acronyms\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API MUST use ISO date-time values with timezone information where dates are exposed.\",\r\n \"relatedAuditItems\": [\r\n \"dates-use-iso\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-DATA-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"domain-modeling\",\r\n \"requirement\": \"The REST API SHOULD use standard codes, controlled vocabularies, and standardized value sets where applicable.\",\r\n \"relatedAuditItems\": [\r\n \"general-data-uses-standard-values\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST describe the business value and feature intent of each endpoint or capability.\",\r\n \"relatedAuditItems\": [\r\n \"endpoint-descriptions-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API MUST include examples for endpoints, request bodies, response bodies, and key attributes.\",\r\n \"relatedAuditItems\": [\r\n \"examples-present\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CX-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"consumer-experience\",\r\n \"requirement\": \"The REST API SHOULD use consistent pagination, filtering, sorting, and response conventions across resources.\",\r\n \"relatedAuditItems\": [\r\n \"design-consistent\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-GET-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use GET for safe read-only operations and MUST NOT define a request body for GET operations.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-POST-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use POST for resource creation and other non-idempotent operations.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-PUT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use PUT only for full resource replacement.\",\r\n \"relatedAuditItems\": [\r\n \"post-for-create-update\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-HTTP-DELETE-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"http-semantics\",\r\n \"requirement\": \"The REST API MUST use DELETE to remove resources.\",\r\n \"relatedAuditItems\": [\r\n \"delete-for-remove\",\r\n \"http-methods-match-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PATH-01\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"resource-modeling\",\r\n \"requirement\": \"The REST API SHOULD keep endpoint paths shallow and avoid more than two resource or sub-resource levels unless explicitly justified.\",\r\n \"relatedAuditItems\": [\r\n \"paths-max-two-resources\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-200-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 200 OK for successful reads and updates that include a response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-no-request-body\",\r\n \"post-returns-200\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-201-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 201 Created and the created resource identifier when a new resource is created.\",\r\n \"relatedAuditItems\": [\r\n \"create-returns-identifiers\",\r\n \"post-returns-201\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API MUST return 204 No Content for successful delete operations that do not return a body.\",\r\n \"relatedAuditItems\": [\r\n \"delete-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-RESP-204-02\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"status-codes\",\r\n \"requirement\": \"The REST API SHOULD return 204 No Content for successful operations that intentionally return no response body.\",\r\n \"relatedAuditItems\": [\r\n \"get-empty-returns-204\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-400-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST define 400 Bad Request responses with specific and actionable validation error information.\",\r\n \"relatedAuditItems\": [\r\n \"400-errors-specific\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-401-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 401 Unauthorized for missing or invalid credentials.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-ERROR-403-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"error-handling\",\r\n \"requirement\": \"The REST API MUST return 403 Forbidden for authenticated clients lacking sufficient permission.\",\r\n \"relatedAuditItems\": [\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-VERSION-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"versioning\",\r\n \"requirement\": \"The REST API MUST define a versioning strategy before production release, and the strategy MUST be supportable by the API gateway.\",\r\n \"relatedAuditItems\": [\r\n \"versioning-decided\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST require authentication for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use token-based authentication or another approved modern authentication mechanism for protected endpoints.\",\r\n \"relatedAuditItems\": [\r\n \"token-auth\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-03\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST enforce object-level and function-level authorization on every protected operation.\",\r\n \"relatedAuditItems\": [\r\n \"401-unauthorized\",\r\n \"403-forbidden\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST mitigate OWASP API risks including broken object level authorization, broken function level authorization, injection, and unrestricted resource consumption.\",\r\n \"relatedAuditItems\": [\r\n \"auth-protection\",\r\n \"rate-limits-enforced\",\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-05\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST use HTTPS or another approved encrypted protocol for all traffic.\",\r\n \"relatedAuditItems\": [\r\n \"uses-https\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-06\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST NOT expose sensitive information in URLs, query strings, logs, or unnecessary response fields.\",\r\n \"relatedAuditItems\": [\r\n \"no-sensitive-data-in-urls\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-07\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API SHOULD use UUIDs or other non-sequential public identifiers where direct database identifiers would increase exposure risk.\",\r\n \"relatedAuditItems\": [\r\n \"pseudo-identifiers\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-SEC-08\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"security\",\r\n \"requirement\": \"The REST API MUST implement CSRF protection where relevant to the authentication model and client interaction pattern.\",\r\n \"relatedAuditItems\": [\r\n \"csrf-protection\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST define and enforce rate limits, throttling, or quotas according to capacity expectations.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-CAPACITY-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"resilience-capacity\",\r\n \"requirement\": \"The REST API MUST implement resilience controls such as timeouts, fallback behavior, and degradation handling according to business impact.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\",\r\n \"encryption-in-transit\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-OBS-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"observability\",\r\n \"requirement\": \"The REST API MUST implement logs, metrics, and monitoring needed to observe validation failures, auth failures, traffic, latency, and dependency health.\",\r\n \"relatedAuditItems\": [\r\n \"rate-limits-enforced\",\r\n \"message-integrity\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published through an API management platform.\",\r\n \"relatedAuditItems\": [\r\n \"published-via-api-management\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be accessible only through approved API gateway paths and managed entry points.\",\r\n \"relatedAuditItems\": [\r\n \"only-via-gateway\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-03\",\r\n \"priority\": \"SHOULD\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API SHOULD be visible in a developer portal with documentation generated from the contract.\",\r\n \"relatedAuditItems\": [\r\n \"visible-in-dev-portal\",\r\n \"docs-auto-generated\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-PUBLISH-04\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"publishing-governance\",\r\n \"requirement\": \"The REST API MUST be published under an approved organizational domain.\",\r\n \"relatedAuditItems\": [\r\n \"official-domain\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-01\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST validate the specification, schema, and examples on every change.\",\r\n \"relatedAuditItems\": [\r\n \"spec-validated-on-change\",\r\n \"schema-and-examples-pass\"\r\n ]\r\n },\r\n {\r\n \"id\": \"REST-AUDIT-02\",\r\n \"priority\": \"MUST\",\r\n \"category\": \"contract-governance\",\r\n \"requirement\": \"The REST API MUST pass concept, design, security, and production-readiness checks before release.\",\r\n \"relatedAuditItems\": [\r\n \"concept-items-audited\",\r\n \"design-items-audited\"\r\n ]\r\n }\r\n ]\r\n}", "draft": false }, { "id": "api-community-engagement-strategies", "slug": "resources/api-community-engagement-strategies", "title": "Strategien für das Engagement der API-Gemeinschaft", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 103, "outcomes": [ "Besseres Verständnis der Grundsätze von Strategien zur Einbindung der API-Gemeinschaft", "Standardisierter Ansatz mit API-Strategien zur Einbindung der Gemeinschaft", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Entwickeln Sie Marketingstrategien, um APIs bei den Zielgruppen bekannt zu machen, einschließlich sozialer Medien, Blogs und Webinare.", "Erstellen Sie Werbematerialien (z. B. Fallstudien, Erfolgsgeschichten), die den Wert und die Vorteile von APIs hervorheben.", "Erstellung von Lehrmaterial (z. B. Tutorials, Dokumentation), das die Funktionen, Vorteile und Nutzungsmuster der API erläutert.", "Engagieren Sie sich mit API-Benutzern über Feedbackschleifen, Support-Kanäle und Community-Foren, um ihre Bedürfnisse zu verstehen und die API-Akzeptanz zu verbessern.", "Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-compliance-best-practices", "slug": "resources/api-compliance-best-practices", "title": "Bewährte Praktiken zur API-Einhaltung", "description": "Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 104, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken der API-Konformität", "Standardisierter Ansatz mit bewährten Praktiken für die API-Einhaltung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.", "Implementieren Sie Maßnahmen, die sicherstellen, dass APIs diese Anforderungen erfüllen, einschließlich Datenverschlüsselung, Zugriffskontrollen und Prüfpfade.", "Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Konformität mit Standards zu überprüfen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-development-best-practices", "slug": "resources/api-development-best-practices", "title": "Bewährte Praktiken der API-Entwicklung", "description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.", "category": "guideline", "icon": "edit-document-outline", "order": 112, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.", "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren." ], "canvasId": null, "sourcePath": "src/snippets/de/api-design-principles-guidance.md", "sourceUrl": null, "contentMarkdown": "## So beginnen Sie mit der API-Bereitstellung auf der Grundlage der vorangegangenen Phasen („Stationen“)\r\nNutzen Sie diesen Leitfaden zu Beginn der `API Delivery` (API-Bereitstellung), nachdem der API-Vertrag (z. B. OpenAPI) und die wichtigsten Ergebnisse aus früheren Stationen geprüft und akzeptiert wurden.\r\nDas Ziel besteht nicht darin, die Implementierung isoliert zu entwickeln. Das Ziel ist es, die vereinbarten Ergebnisse aus früheren Stationen in konkrete Codestrukturen, Validierungsregeln, Laufzeitverhalten und Entscheidungen zur API-Produktbereitstellung umzusetzen.\r\n\r\n---\r\n\r\n### 1. Beginnen Sie mit dem validierten Vertrag\r\n- Behandeln Sie den validierten API-Vertrag als Hauptbezugspunkt für Implementierungsentscheidungen.\r\n- Halten Sie den Vertrag und die Implementierung während der gesamten API-Produktbereitstellung aufeinander abgestimmt.\r\n- Nutzen Sie den Vertrag als Grundlage für die Validierung von Anfragen, die Zuordnung von Antworten, die Dokumentation und Tests.\r\n\r\n---\r\n\r\n### 2. Verwenden Sie Domänen-Ergebnisse, um die geschäftliche Bedeutung zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Domain Canvas` als Leitfaden für die Namensgebung, die Aufteilung der Implementierung in klare geschäftliche Verantwortlichkeiten und die Verbindung verschiedener Backend-Systeme, ohne deren Unterschiede offenzulegen.\r\n- Bewahren Sie die validierten Bedeutungen von Entitäten, Attributen, Status und „Source-of-Truth“-Regeln.\r\n- Vermeiden Sie es, backend-spezifische Modelle oder Inkonsistenzen in die öffentliche API einfließen zu lassen.\r\n\r\n---\r\n\r\n### 3. Nutzen Sie Journey-Ergebnisse, um kritische Abläufe zu bewahren\r\n- Nutzen Sie die Ergebnisse des `Customer Journey Canvas`, um zu ermitteln, welche Benutzerabläufe am wichtigsten sind und zuerst unterstützt werden müssen.\r\n- Nutzen Sie die Ergebnisse des `API Consumer Experience`, um die API verständlich, vorhersehbar und einfach zu integrieren zu halten.\r\n- Lassen Sie die vereinbarten Journey-Prioritäten entscheiden, welche Implementierungspfade die höchste Zuverlässigkeit, die geringste Latenz, die klarsten Fehlermeldungen und den stärksten operativen Fokus erfordern.\r\n\r\n---\r\n\r\n### 4. Nutzen Sie die Ergebnisse der Wertversprechen, um den Kundennutzen zu erhalten\r\n- Nutzen Sie die Ergebnisse des `API Value Proposition Canvas`, um die Implementierung auf die vereinbarten Probleme, Vorteile und API-Funktionen zu fokussieren.\r\n- Behalten Sie die Feldbedeutungen, das Verhalten und die Versprechen bei, die die API in den früheren Phasen wertvoll gemacht haben.\r\n- Stellen Sie sicher, dass Fehlerbehandlung, Aktualität und Namensgebung sowohl die beabsichtigte Entwicklererfahrung als auch den geschäftlichen Anwendungsfall unterstützen.\r\n\r\n---\r\n\r\n### 5. Nutzen Sie die Ergebnisse der Architektur, um Entscheidungen zur Laufzeit zu gestalten\r\n- Nutzen Sie die Ergebnisse des `Business Impact Canvas`, um Entscheidungen zu Ausfallsicherheit, Timeouts, Fallbacks und Leistungsminderungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Locations Canvas`, um Netzwerkgrenzen, Vertrauensgrenzen, Zugriffspfade und Bereitstellungsbeschränkungen zu leiten.\r\n- Nutzen Sie die Ergebnisse des `Capacity Canvas`, um Ratenbegrenzungen, Caching, Skalierung und das Verhalten bei Spitzenlasten zu leiten.\r\n- Nutzen Sie die Leitlinien aus `API Metrics And Analytics`, um zu entscheiden, was ab der ersten Implementierung beobachtet werden muss.\r\n\r\n---\r\n\r\n### 6. Nutzen Sie die Ergebnisse aus dem Interaktions- und Protokoll-Design zur Gestaltung der Codestruktur\r\n- Nutzen Sie die Ergebnisse aus dem `Interaction Canvas`, um zu vermeiden, dass nicht unterstützte Interaktionsstile zu früh implementiert werden.\r\n- Nutzen Sie die Design-Ergebnisse aus `REST`, `Event` oder `GraphQL`, um protokollspezifisches Verhalten bei Anfragen, Antworten und Validierungen zu gestalten.\r\n- Spiegeln Sie den gewählten Interaktionsstil klar in der Codestruktur, den Verantwortlichkeiten und der Teststrategie wider.\r\n\r\n---\r\n\r\n### 7. Nutzen Sie die Ergebnisse der Überprüfung, um die Umsetzung zu verbessern, bevor die Codierung zu weit fortgeschritten ist\r\n- Nutzen Sie die Ergebnisse der Überprüfung, um Unklarheiten zu beseitigen, bevor sich die Implementierung über den gesamten Code verteilt.\r\n- Beheben Sie unklare Anforderungsregeln, fehlende Validierungen, schwache Fehlerverträge und operative Lücken frühzeitig.\r\n- Betrachten Sie das Audit als einen Zyklus zur Designverbesserung vor der Produktion, nicht nur als abschließende Entscheidungsinstanz.\r\n\r\n---\r\n\r\n### 8. Wenden Sie die Leitlinien an und fassen Sie sie anschließend zusammen\r\n- Wenden Sie diese Leitlinien auf die aktuelle API und den Implementierungsplan an.\r\n- Fassen Sie die Auswirkungen auf die Codestruktur, die Anfragevalidierung, die Quellintegration, die Sicherheit, die Überwachung und Warnmeldungen sowie das Testen zusammen.\r\n- Erstellen Sie kein separates Lieferartefakt, es sei denn, das Team oder der Benutzer benötigt ausdrücklich eines.\r\n", "draft": true }, { "id": "api-metrics-and-analytics", "slug": "resources/api-metrics-and-analytics", "title": "API-Metriken und -Analysen", "description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.", "category": "guideline", "icon": "edit-document-outline", "order": 119, "outcomes": [ "Besseres Verständnis von API-Metriken und Analysegrundsätzen", "Standardisierter Ansatz mit API Metrics And Analytics", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige Leistungsindikatoren (KPIs), um den API-Erfolg anhand der Unternehmensziele zu messen.", "Definieren und überwachen Sie Leistungsmetriken (z. B. API-Aufrufe, Latenz, Fehlerraten) und Adoptionsmetriken (z. B. NPS).", "Überwachung von API-Initiativen, um die Einhaltung von Betriebsrichtlinien und Governance-Praktiken zu gewährleisten" ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-onboarding-best-practices", "slug": "resources/api-onboarding-best-practices", "title": "Bewährte Praktiken beim API-Onboarding", "description": "Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.", "category": "guideline", "icon": "edit-document-outline", "order": 121, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken beim API-Onboarding", "Standardisierter Ansatz unter Verwendung von API Onboarding Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie den Weg des API-Kunden von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie die wichtigsten Berührungspunkte und Schmerzpunkte.", "Entwicklung von Onboarding-Prozessen und -Ressourcen, damit API-Kunden verstehen, wie sie APIs effektiv nutzen können.", "Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-portfolio-management-guidelines", "slug": "resources/api-portfolio-management-guidelines", "title": "Leitlinien für das API-Portfolio-Management", "description": "Ein Leitfaden für die strategische Verwaltung der API-Suite eines Unternehmens - Priorisierung von APIs, Zuweisung von Ressourcen und Überwachung der Leistung über den gesamten Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 123, "outcomes": [ "Besseres Verständnis der Grundsätze der API-Portfolioverwaltung", "Standardisierter Ansatz mit API-Portfolio-Management-Leitlinien", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definition von Portfoliomanagementverfahren, die die Prozesse zur Verwaltung des API-Portfolios, einschließlich Priorisierung, Überwachung und Optimierung, umreißen.", "Definieren Sie Budget- und Ressourcenverwaltungspraktiken, die die Prozesse für die Verwaltung von Budgets und Ressourcen für API-Initiativen umreißen.", "Festlegung von Kriterien für die Bewertung und Priorisierung von Budgetzuweisungen auf der Grundlage des Geschäftswerts, der Auswirkungen und der Ausrichtung auf strategische Initiativen.", "Überwachen Sie das API-Portfolio, um sicherzustellen, dass die APIs einen Mehrwert liefern, die Leistungserwartungen erfüllen und mit den Geschäftszielen übereinstimmen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-security-best-practices", "slug": "resources/api-security-best-practices", "title": "Bewährte Praktiken für die API-Sicherheit", "description": "Eine Reihe praktikabler Kontrollen zur Sicherung von APIs, einschließlich Authentifizierung, Autorisierung, Verschlüsselung, Ratenbegrenzung und Konformitätsprüfungen auf Pipeline-Ebene.", "category": "guideline", "icon": "edit-document-outline", "order": 130, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Sicherheitspraktiken", "Standardisierter Ansatz mit bewährten API-Sicherheitspraktiken", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.", "Implementieren Sie Sicherheitsmaßnahmen wie Authentifizierung, Autorisierung, Verschlüsselung und Ratenbegrenzung, um APIs vor Bedrohungen zu schützen.", "Implementieren Sie automatisierte Sicherheitsprüfungen und Compliance-Validierungen in der CI/CD-Pipeline, um sicherzustellen, dass APIs sicher und konform sind." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-team-structure-guidelines", "slug": "resources/api-team-structure-guidelines", "title": "Leitlinien für die API-Teamstruktur", "description": "Organisatorische Anleitung zur Definition von Rollen und Verantwortlichkeiten innerhalb von API-Teams, um Klarheit, Zusammenarbeit und Verantwortlichkeit zu gewährleisten.", "category": "guideline", "icon": "edit-document-outline", "order": 132, "outcomes": [ "Besseres Verständnis der Grundsätze der API-Teamstruktur", "Standardisierter Ansatz unter Verwendung der API-Teamstruktur-Richtlinien", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Teamstrukturen und Rollen für API-Teams, einschließlich API-Produktverantwortliche, Entwickler, Architekten und Betriebsleiter." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-testing-best-practices", "slug": "resources/api-testing-best-practices", "title": "Bewährte Praktiken für API-Tests", "description": "Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.", "category": "guideline", "icon": "edit-document-outline", "order": 133, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter API-Testverfahren", "Standardisierter Ansatz unter Verwendung bewährter Praktiken für API-Tests", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.", "Integrieren Sie funktionale und nicht-funktionale Tests in die CI/CD-Pipeline, um sicherzustellen, dass APIs den Qualitätsstandards entsprechen.", "Verwenden Sie automatisierte Testtools, um API-Funktionalität, Sicherheit und Leistung zu validieren." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-training-programs", "slug": "resources/api-training-programs", "title": "API-Schulungsprogramme", "description": "Eine Roadmap für die Weiterbildung von Teams mit strukturierten Lernpfaden für API-Design, Governance, Leistung und Sicherheit.", "category": "guideline", "icon": "edit-document-outline", "order": 134, "outcomes": [ "Besseres Verständnis der Grundsätze von API-Schulungsprogrammen", "Standardisierter Ansatz mit API-Schulungsprogrammen", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Identifizieren Sie wichtige API-Fähigkeiten und Wissensbereiche, die verbessert werden müssen, wie z. B. API-Design, Sicherheit und Leistung.", "Fördern Sie das kontinuierliche Lernen durch Online-Kurse, Zertifizierungen und Engagement in der Gemeinschaft.", "Bereitstellung von Schulungen und Ressourcen, um Teams dabei zu helfen, eine API-first-Mentalität zu entwickeln und die Vorteile von APIs zu verstehen.", "Bereitstellung von Schulungsprogrammen, Workshops und Ressourcen, um Teams bei der Verbesserung ihrer API-Fähigkeiten und -Kenntnisse zu unterstützen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "api-versioning-best-practices", "slug": "resources/api-versioning-best-practices", "title": "Bewährte Praktiken der API-Versionierung", "description": "Strategien für die Einführung, Pflege und Abschaffung von API-Versionen unter Wahrung der Abwärtskompatibilität und des Vertrauens der Verbraucher.", "category": "guideline", "icon": "edit-document-outline", "order": 138, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Verfahren der API-Versionierung", "Standardisierter Ansatz mit bewährten Praktiken für die API-Versionierung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Versionsstrategien für APIs, um Änderungen zu verwalten und Abwärtskompatibilität zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "apiops-CI-CD-for-apis", "slug": "resources/apiops-CI-CD-for-apis", "title": "APIOps CI/CD für APIs", "description": "Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.", "category": "guideline", "icon": "edit-document-outline", "order": 140, "outcomes": [ "Besseres Verständnis der Grundsätze von CI/CD für APIs", "Standardisierter Ansatz mit CI/CD für APIs", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.", "Integrieren Sie automatisierte Tests in die CI/CD-Pipeline, um eine kontinuierliche Validierung der API-Qualität sicherzustellen.", "Implementierung von Bereitstellungsstrategien (z. B. blau-grüne Bereitstellungen, Canary-Releases) zur Minimierung der Risiken bei API-Releases.", "Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "competitor-analysis-template", "slug": "resources/competitor-analysis-template", "title": "Mitbewerber-Analyse Vorlage", "description": "Ein strukturiertes Arbeitsblatt zum Benchmarking Ihres API-Angebots im Vergleich zu den Wettbewerbern, indem Stärken, Schwächen und Wertunterscheidungsmerkmale dargestellt werden.", "category": "guideline", "icon": "edit-document-outline", "order": 143, "outcomes": [ "Besseres Verständnis der Grundsätze für die Analyse von Wettbewerbern", "Standardisierter Ansatz unter Verwendung der Schablone für die Wettbewerberanalyse", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Führen Sie eine Wettbewerbsanalyse durch, um die wichtigsten Wettbewerber und deren API-Angebote zu ermitteln.", "Analysieren Sie die APIs der Mitbewerber, um deren Stärken, Schwächen und Alleinstellungsmerkmale zu verstehen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "contract-first-design", "slug": "resources/contract-first-design", "title": "Vertrag Erstes Design", "description": "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.", "category": "guideline", "icon": "edit-document-outline", "order": 146, "outcomes": [ "Besseres Verständnis der Grundsätze der Vertragsgestaltung", "Standardisierter Ansatz mit Contract First Design", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.", "Definieren Sie API-Verträge, in denen die Erwartungen, Verantwortlichkeiten und Nutzungsrichtlinien für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate (z. B. OpenAPI, AsyncAPI), um maschinenlesbare API-Verträge zu erstellen, die sich leicht austauschen und validieren lassen." ], "canvasId": null, "sourcePath": "src/snippets/api-contract-example.yaml", "sourceUrl": null, "contentMarkdown": "openapi: 3.0.3\r\ninfo:\r\n title: Sample Catalog API\r\n version: 1.0.0\r\n description: |\r\n Starter example for a read-only APIOps Cycles API.\r\n This example keeps the contract audit-friendly and easy to extend.\r\nservers:\r\n - url: /v1\r\n description: Versioned API base path\r\ntags:\r\n - name: catalog\r\n description: Browse and search catalog items\r\npaths:\r\n /items:\r\n get:\r\n tags: [catalog]\r\n summary: List catalog items\r\n description: Returns a paginated list of public catalog items.\r\n operationId: listItems\r\n parameters:\r\n - $ref: \"#/components/parameters/searchTerm\"\r\n - $ref: \"#/components/parameters/categoryId\"\r\n - $ref: \"#/components/parameters/page\"\r\n - $ref: \"#/components/parameters/pageSize\"\r\n responses:\r\n \"200\":\r\n description: Item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n examples:\r\n default:\r\n value:\r\n data:\r\n - itemId: item-123\r\n slug: blue-widget\r\n name: Blue Widget\r\n status: published\r\n page:\r\n number: 1\r\n size: 20\r\n totalItems: 1\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"429\":\r\n $ref: \"#/components/responses/TooManyRequests\"\r\n /items/{itemId}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by id\r\n description: Returns a single public catalog item by opaque identifier.\r\n operationId: getItemById\r\n parameters:\r\n - $ref: \"#/components/parameters/itemId\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"400\":\r\n $ref: \"#/components/responses/BadRequest\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /items/by-slug/{slug}:\r\n get:\r\n tags: [catalog]\r\n summary: Get item by slug\r\n description: Returns a single item by public slug.\r\n operationId: getItemBySlug\r\n parameters:\r\n - $ref: \"#/components/parameters/slug\"\r\n responses:\r\n \"200\":\r\n description: Item details\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemDetail\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\n /categories/{categoryId}/items:\r\n get:\r\n tags: [catalog]\r\n summary: List items in category\r\n description: Returns public items in a category.\r\n operationId: listItemsByCategory\r\n parameters:\r\n - $ref: \"#/components/parameters/categoryId\"\r\n responses:\r\n \"200\":\r\n description: Category item list\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ItemListResponse\"\r\n \"404\":\r\n $ref: \"#/components/responses/NotFound\"\r\ncomponents:\r\n parameters:\r\n itemId:\r\n name: itemId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: item-123\r\n slug:\r\n name: slug\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9]+(?:-[a-z0-9]+)*$\"\r\n example: blue-widget\r\n categoryId:\r\n name: categoryId\r\n in: path\r\n required: true\r\n schema:\r\n type: string\r\n pattern: \"^[a-z0-9][a-z0-9-]{1,63}$\"\r\n example: home-goods\r\n searchTerm:\r\n name: searchTerm\r\n in: query\r\n required: false\r\n schema:\r\n type: string\r\n minLength: 1\r\n example: widget\r\n page:\r\n name: page\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n default: 1\r\n pageSize:\r\n name: pageSize\r\n in: query\r\n required: false\r\n schema:\r\n type: integer\r\n minimum: 1\r\n maximum: 100\r\n default: 20\r\n responses:\r\n BadRequest:\r\n description: Validation failed\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n examples:\r\n default:\r\n value:\r\n code: BAD_REQUEST\r\n message: Invalid request\r\n NotFound:\r\n description: Resource not found\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n TooManyRequests:\r\n description: Rate limit exceeded\r\n headers:\r\n Retry-After:\r\n schema:\r\n type: integer\r\n description: Seconds until the next allowed request.\r\n content:\r\n application/json:\r\n schema:\r\n $ref: \"#/components/schemas/ErrorResponse\"\r\n schemas:\r\n ItemListResponse:\r\n type: object\r\n required: [data, page]\r\n properties:\r\n data:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/ItemSummary\"\r\n page:\r\n $ref: \"#/components/schemas/Page\"\r\n ItemSummary:\r\n type: object\r\n required: [itemId, slug, name, status]\r\n properties:\r\n itemId:\r\n type: string\r\n slug:\r\n type: string\r\n name:\r\n type: string\r\n status:\r\n type: string\r\n enum: [published, hidden]\r\n ItemDetail:\r\n allOf:\r\n - $ref: \"#/components/schemas/ItemSummary\"\r\n - type: object\r\n properties:\r\n description:\r\n type: string\r\n categories:\r\n type: array\r\n items:\r\n type: string\r\n variants:\r\n type: array\r\n items:\r\n $ref: \"#/components/schemas/Variant\"\r\n Variant:\r\n type: object\r\n required: [variantId, sku, price, inventory]\r\n properties:\r\n variantId:\r\n type: string\r\n sku:\r\n type: string\r\n price:\r\n $ref: \"#/components/schemas/Price\"\r\n inventory:\r\n $ref: \"#/components/schemas/Inventory\"\r\n Price:\r\n type: object\r\n required: [amount, currency]\r\n properties:\r\n amount:\r\n type: number\r\n format: decimal\r\n currency:\r\n type: string\r\n example: EUR\r\n Inventory:\r\n type: object\r\n required: [available]\r\n properties:\r\n available:\r\n type: integer\r\n minimum: 0\r\n reserved:\r\n type: integer\r\n minimum: 0\r\n source:\r\n type: string\r\n Page:\r\n type: object\r\n required: [number, size, totalItems]\r\n properties:\r\n number:\r\n type: integer\r\n size:\r\n type: integer\r\n totalItems:\r\n type: integer\r\n ErrorResponse:\r\n type: object\r\n required: [code, message]\r\n properties:\r\n code:\r\n type: string\r\n message:\r\n type: string\r\n", "draft": true }, { "id": "cross-functional-collaboration-best-practices", "slug": "resources/cross-functional-collaboration-best-practices", "title": "Best Practices für die funktionsübergreifende Zusammenarbeit", "description": "Praktiken zur Erleichterung der Kommunikation und Abstimmung zwischen Geschäfts- und Technikerteams bei der Planung oder Bereitstellung von APIs.", "category": "guideline", "icon": "edit-document-outline", "order": 147, "outcomes": [ "Besseres Verständnis der Grundsätze der bewährten funktionsübergreifenden Zusammenarbeit", "Standardisierter Ansatz mit funktionsübergreifenden Best Practices für die Zusammenarbeit", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Fördern Sie die funktionsübergreifende Zusammenarbeit zwischen API-Teams, Geschäftseinheiten und Interessenvertretern, um API-Initiativen mit Geschäftszielen abzustimmen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "data-privacy-guidelines", "slug": "resources/data-privacy-guidelines", "title": "Leitlinien zum Datenschutz", "description": "Designüberlegungen, um sicherzustellen, dass APIs durch Anonymisierung und Zugriffskontrollen Datenschutzbestimmungen wie GDPR erfüllen.", "category": "guideline", "icon": "edit-document-outline", "order": 148, "outcomes": [ "Besseres Verständnis der Grundsätze der Datenschutzleitlinien", "Standardisierter Ansatz mit Datenschutzrichtlinien", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Gewährleistung des Datenschutzes für die Nutzer durch die Umsetzung von Datenschutzmaßnahmen wie Anonymisierung und Zugangskontrolle." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "domainCanvas", "slug": "resources/domain-canvas", "title": "Domain Canvas", "description": "Ein Modellierungstool zur Definition und Kommunikation der wichtigsten Entitäten und Beziehungen in Ihrer Domäne, das die semantische Konsistenz über APIs hinweg gewährleistet.", "category": "canvas", "icon": "dashboard-outline", "order": 152, "outcomes": [ "Besseres Verständnis der Grundsätze des Domain Canvas", "Standardisierter Ansatz mit Domain Canvas", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle APIs zu schaffen." ], "canvasId": "domainCanvas", "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": false }, { "id": "ecosystem-vision-template", "slug": "resources/ecosystem-vision-template", "title": "Ökosystem Vision Vorlage", "description": "Ein strategisches Planungsinstrument zur Definition des API-Ökosystems, einschließlich Zielpartnern, Wertschöpfungsketten und Integrationsmöglichkeiten.", "category": "guideline", "icon": "edit-document-outline", "order": 154, "outcomes": [ "Besseres Verständnis der Grundsätze der Ökosystem-Vision-Vorlage", "Standardisierter Ansatz mit Ecosystem Vision Template", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Führen Sie Marktforschung durch, um Trends, Chancen und Bedrohungen in der API-Landschaft zu identifizieren.", "Identifizieren Sie die wichtigsten Ökosystempartner und -akteure, die von dem Ökosystem profitieren oder zu ihm beitragen werden.", "Identifizieren Sie Marktlücken, die Ihre APIs auf der Grundlage der Angebote der Wettbewerber füllen können.", "Identifizieren Sie potenzielle Partner, deren APIs Ihre API-Fähigkeiten und Ihr Wertversprechen verbessern können.", "Entwickeln Sie eine Differenzierungsstrategie, die die einzigartigen Merkmale und Vorteile Ihrer APIs hervorhebt.", "Definieren Sie die Vision des Ökosystems für Ihre APIs, einschließlich der Frage, wie sie mit anderen Systemen und Plattformen interagieren werden.", "Entwicklung von APIs, die eine nahtlose Integration und Zusammenarbeit innerhalb des Ökosystems ermöglichen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "industry-standards-and-best-practices", "slug": "resources/industry-standards-and-best-practices", "title": "Industriestandards und bewährte Praktiken", "description": "Eine Referenzressource für die Anpassung von API-Design und -Betrieb an weithin anerkannte Industrierahmenwerke und -spezifikationen.", "category": "guideline", "icon": "edit-document-outline", "order": 157, "outcomes": [ "Besseres Verständnis der Industriestandards und der Grundsätze bewährter Verfahren", "Standardisierter Ansatz mit Industriestandards und Best Practices", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Ermittlung von Industriestandards und bewährten Verfahren, um sicherzustellen, dass APIs wettbewerbsfähig und konform sind." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "partner-integration-guidelines", "slug": "resources/partner-integration-guidelines", "title": "Leitlinien für die Integration von Partnern", "description": "Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.", "category": "guideline", "icon": "edit-document-outline", "order": 164, "outcomes": [ "Besseres Verständnis der Grundsätze der Leitlinien für die Integration von Partnern", "Standardisierter Ansatz unter Verwendung der Richtlinien zur Partnerintegration", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Festlegung von Integrationsprozessen und Richtlinien für die Zusammenarbeit mit Partnern, einschließlich technischer Integration, Datenaustausch und Unterstützung.", "Überwachen Sie die API-Leistung und -Einhaltung der Partner, um Zuverlässigkeit und Übereinstimmung mit Ihrer API-Strategie zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "role-communication-best-practices", "slug": "resources/role-communication-best-practices", "title": "Bewährte Praktiken der Rollenkommunikation", "description": "Werkzeuge, um zu definieren und zu dokumentieren, wer für was innerhalb von API-Initiativen verantwortlich ist, um sicherzustellen, dass Übergaben und Verantwortlichkeiten klar sind.", "category": "guideline", "icon": "edit-document-outline", "order": 167, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Praktiken der Rollenkommunikation", "Standardisierter Ansatz unter Verwendung von Best Practices für die Rollenkommunikation", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Legen Sie klare Verantwortlichkeiten für jede Rolle fest, einschließlich API-Design, Entwicklung, Testen und Betrieb.", "Sicherstellen, dass die Rollen und Verantwortlichkeiten allen Teammitgliedern und Interessenvertretern mitgeteilt werden, um eine Abstimmung zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "scalable-infrastructure-best-practices", "slug": "resources/scalable-infrastructure-best-practices", "title": "Bewährte Praktiken für eine skalierbare Infrastruktur", "description": "Architektonische Anleitungen, um sicherzustellen, dass APIs in einer Infrastruktur bereitgestellt werden, die Nutzungsspitzen und Wachstum elastisch bewältigen kann.", "category": "guideline", "icon": "edit-document-outline", "order": 168, "outcomes": [ "Besseres Verständnis der Grundsätze der bewährten Praktiken für skalierbare Infrastrukturen", "Standardisierter Ansatz mit bewährten Praktiken für skalierbare Infrastrukturen", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Entwerfen Sie eine skalierbare und robuste API-Infrastruktur unter Verwendung von Cloud-nativen Mustern und Technologien.", "Überwachen Sie die Leistung und Kapazität der Infrastruktur, um sicherzustellen, dass sie die wachsende Nachfrage bewältigen kann." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "service-agreement-template", "slug": "resources/service-agreement-template", "title": "Vorlage für eine Dienstleistungsvereinbarung", "description": "Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.", "category": "guideline", "icon": "edit-document-outline", "order": 172, "outcomes": [ "Besseres Verständnis der Grundsätze der Vorlage für Dienstleistungsvereinbarungen", "Standardisierter Ansatz mit Vorlage für Dienstleistungsvereinbarung", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Definieren Sie Servicevereinbarungen, in denen die Erwartungen, Servicelevel und Verantwortlichkeiten für jede API festgelegt sind.", "Verwenden Sie standardisierte Formate, um maschinenlesbare Servicevereinbarungen zu erstellen, die sich leicht austauschen und validieren lassen.", "Sicherstellen, dass die Dienstleistungsvereinbarungen von den Beteiligten überprüft und genehmigt werden, um die Übereinstimmung und Klarheit zu gewährleisten." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "stakeholder-engagement-best-practices", "slug": "resources/stakeholder-engagement-best-practices", "title": "Bewährte Praktiken zur Einbindung von Stakeholdern", "description": "Einbindungstaktiken für die Ausrichtung interner und externer Interessengruppen auf gemeinsame API-Ziele, -Wert und -Governance.", "category": "guideline", "icon": "edit-document-outline", "order": 173, "outcomes": [ "Besseres Verständnis der Grundsätze bewährter Verfahren für die Einbeziehung von Stakeholdern", "Standardisierter Ansatz unter Verwendung von Best Practices für die Einbeziehung von Stakeholdern", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Einbindung von Interessengruppen, um die Abstimmung und Unterstützung von API-Initiativen sicherzustellen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "test-automation-frameworks", "slug": "resources/test-automation-frameworks", "title": "Testautomatisierungs-Frameworks", "description": "Empfohlene Tools und Muster für die Automatisierung von API-Vertrags-, Regressions- und Integrationstests in verschiedenen Umgebungen.", "category": "guideline", "icon": "edit-document-outline", "order": 174, "outcomes": [ "Besseres Verständnis der Grundsätze von Testautomatisierungssystemen", "Standardisierter Ansatz mit Testautomatisierungs-Frameworks", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Implementierung von Testautomatisierungs-Frameworks, die Vertragstests, Integrationstests und End-to-End-Tests unterstützen." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "vendor-management-best-practices", "slug": "resources/vendor-management-best-practices", "title": "Bewährte Praktiken im Lieferantenmanagement", "description": "Rahmen für die Bewertung und Verwaltung von externen API-Anbietern und Integrationen von Drittanbietern auf der Grundlage von Risiko, Leistung und Compliance.", "category": "guideline", "icon": "edit-document-outline", "order": 178, "outcomes": [ "Besseres Verständnis der Grundsätze für bewährte Praktiken im Lieferantenmanagement", "Standardisierter Ansatz mit bewährten Praktiken für das Lieferantenmanagement", "Verbesserte Umsetzung der entsprechenden API-Praktiken" ], "steps": [ "Einrichtung von Prozessen zur Verwaltung von Anbietern, um Drittanbieter von APIs zu bewerten, einzubinden und zu überwachen.", "Definieren Sie Kriterien für die Bewertung von Anbieter-APIs, einschließlich Zuverlässigkeit, Sicherheit und Compliance." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "integration-style-selection-guide", "slug": "resources/integration-style-selection-guide", "title": "Leitfaden zur Auswahl des Implementierungsstils", "description": "Orientierung zur Auswahl zwischen API, Event, Datei, Stream, Datenprodukt, direkter Integration oder hybriden Implementierungsstilen auf Grundlage von Anforderungen und Rahmenbedingungen.", "category": "guideline", "icon": "edit-document-outline", "order": 180, "outcomes": [ "Begründeter Implementierungsstil für die Integration", "Abwägungen zwischen den Optionen für den Implementierungsstil dokumentiert", "Ausgewählter Stil auf Anforderungen von Nutzern, Plattform, Daten und Betrieb zurückführbar" ], "steps": [ "Vergleichen Sie tragfähige Implementierungsstile anhand von Latenz, Volumen, Kopplung, Datenverantwortung, Aktualität, Governance und Betriebsfähigkeit.", "Identifizieren Sie, wann API, Event, Datei, Stream, Datenprodukt, direkte Integration oder hybride Ansätze zum Anwendungsfall passen.", "Dokumentieren Sie Einschränkungen, Risiken und Plattformabhängigkeiten für den ausgewählten Implementierungsstil.", "Halten Sie fest, warum verworfene Alternativen nicht ausgewählt wurden." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "process-workflow-design-guide", "slug": "resources/process-workflow-design-guide", "title": "Leitfaden für Prozess- und Workflow-Design", "description": "Orientierung zur Modellierung von Prozessschritten, Rollen, Übergaben, Entscheidungspunkten, Zuständen, Eingaben, Ausgaben und Ausnahmen, die einen Automatisierungs-Workflow prägen.", "category": "guideline", "icon": "edit-document-outline", "order": 181, "outcomes": [ "Klares Design des Automatisierungs-Workflows", "Prozessschritte und Übergaben vor der Implementierung dokumentiert", "Workflow-Zustände, Eingaben, Ausgaben und Ausnahmewege verstanden" ], "steps": [ "Modellieren Sie den aktuellen und den Ziel-Prozessfluss einschließlich menschlicher und systemseitiger Verantwortlichkeiten.", "Identifizieren Sie Workflow-Auslöser, Zustände, Entscheidungen, Dateneingaben, Ausgaben und Abschlusskriterien.", "Dokumentieren Sie Übergaben zwischen Nutzern, Systemen, Betrieb und Supportrollen.", "Bestätigen Sie, welche Schritte automatisiert werden sollen und welche menschliches Urteilsvermögen erfordern." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "decision-business-rules-guide", "slug": "resources/decision-business-rules-guide", "title": "Leitfaden für Entscheidungen und Geschäftsregeln", "description": "Orientierung zur Erfassung von Regeln, Schwellenwerten, Entscheidungen, Genehmigungen, Eignungsprüfungen und Regelverantwortung für das Automatisierungsdesign.", "category": "guideline", "icon": "edit-document-outline", "order": 182, "outcomes": [ "Explizite Entscheidungen und Geschäftsregeln", "Regeln und Schwellenwerte mit Verantwortlichen dokumentiert", "Automatisierungsentscheidungen auf Richtlinien, Prozesse oder Geschäftsabsicht zurückführbar" ], "steps": [ "Listen Sie Entscheidungen auf, die die Automatisierung treffen oder unterstützen muss.", "Dokumentieren Sie Regelbedingungen, Schwellenwerte, Ausnahmen, Genehmigungen und Eskalationspunkte.", "Identifizieren Sie Regelverantwortliche und Änderungsgovernance für jeden Entscheidungsbereich." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-trigger-handoff-exception-guide", "slug": "resources/automation-trigger-handoff-exception-guide", "title": "Leitfaden für Automatisierungsauslöser, Übergaben und Ausnahmen", "description": "Orientierung zur Definition von Automatisierungsauslösern, menschlichen Übergaben, Ausnahmebehandlung, Wiederholungen, Ausgleichsmaßnahmen und Support-Eskalationswegen.", "category": "guideline", "icon": "edit-document-outline", "order": 183, "outcomes": [ "Definierte Automatisierungsauslöser und Ausnahmewege", "Menschliche Übergaben und Support-Eskalationen sind explizit", "Ausnahmen, Wiederholungen und Ausgleichsmaßnahmen sind vor der Bereitstellung entworfen" ], "steps": [ "Definieren Sie Ereignisse, Zeitpläne, Nutzeraktionen oder Systemzustände, die die Automatisierung auslösen.", "Modellieren Sie Übergaben von der Automatisierung an Nutzer, Betreiber oder Supportteams.", "Dokumentieren Sie Ausnahmen, Wiederholungsregeln, Timeout-Verhalten und Rückfallwege.", "Definieren Sie Warnungen und Eskalationsschwellen für fehlgeschlagene oder uneindeutige Automatisierungsergebnisse." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-testing-guide", "slug": "resources/automation-testing-guide", "title": "Leitfaden für Automatisierungstests", "description": "Orientierung zum Testen automatisierter Workflows, Entscheidungen, Integrationen, Ausnahmen, Rollback-Verhalten, Überwachung und Nutzerauswirkungen vor der Veröffentlichung.", "category": "guideline", "icon": "edit-document-outline", "order": 184, "outcomes": [ "Validiertes Automatisierungsverhalten", "Workflow-, Regel-, Ausnahme- und Integrationstests definiert", "Veröffentlichungssicherheit für automatisierte und menschlich unterstützte Pfade" ], "steps": [ "Erstellen Sie Tests für Standardabläufe, Grenzfälle, Ausnahmen, Wiederholungen und Übergaben.", "Validieren Sie Geschäftsregeln und Entscheidungsergebnisse mit repräsentativen Daten.", "Testen Sie Rollback, Wiederherstellung, Beobachtbarkeit und manuelle Eingriffspfade.", "Beziehen Sie Nutzer und Betreiber in Abnahmetests ein, wenn die Automatisierung Arbeitsweisen verändert." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-operational-ownership-guide", "slug": "resources/automation-operational-ownership-guide", "title": "Leitfaden für die betriebliche Verantwortung von Automatisierungen", "description": "Orientierung zur Definition von Verantwortung, Runbooks, Überwachung, Support, Monitoring, Änderungskontrolle und kontinuierlicher Verbesserung für Automatisierungen.", "category": "guideline", "icon": "edit-document-outline", "order": 185, "outcomes": [ "Klares Betriebsmodell für die Automatisierung", "Verantwortlichkeiten für Eigentum, Support und Eskalation zugewiesen", "Monitoring- und Änderungspraktiken für den Live-Betrieb bereit" ], "steps": [ "Definieren Sie fachliche, technische und betriebliche Verantwortliche für die Automatisierung.", "Dokumentieren Sie Runbooks, Supportwege, Monitoring-Signale, Serviceerwartungen und Eskalationsregeln.", "Legen Sie Änderungskontrolle und Review-Praktiken für Workflow-, Plattform- und Regeländerungen fest." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-rollback-supervision-guide", "slug": "resources/automation-rollback-supervision-guide", "title": "Leitfaden für Rollback und Überwachung von Automatisierungen", "description": "Orientierung zur Gestaltung von Rollback-, Pausen-, manuellen Übersteuerungs-, Monitoring-, Überwachungs- und Wiederherstellungspfaden für Automatisierungen.", "category": "guideline", "icon": "edit-document-outline", "order": 186, "outcomes": [ "Kontrollierte Wiederherstellungspfade für Automatisierungen", "Rollback-, Pausen- und Übersteuerungsverhalten dokumentiert", "Überwachungsbedarf und Wiederherstellungsverantwortlichkeiten definiert" ], "steps": [ "Identifizieren Sie Aktionen, die rückgängig gemacht, pausiert oder manuell übersteuert werden können müssen.", "Definieren Sie Rollback-, Kompensations- und Wiederherstellungsverfahren für fehlgeschlagene oder falsche Automatisierungsergebnisse.", "Dokumentieren Sie Überwachungsschwellen, Warnungen und manuelle Entscheidungspunkte.", "Validieren Sie Wiederherstellungsverfahren vor der Veröffentlichung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-readiness-checklist", "slug": "resources/automation-readiness-checklist", "title": "Checkliste zur Automatisierungsbereitschaft", "description": "Eine Checkliste zur Validierung von Automatisierungs-Workflow, Kontrollen, Risiko, Compliance, menschlicher Aufsicht, Testnachweisen, Rollback, Betrieb und Veröffentlichungsbereitschaft.", "category": "checklist", "icon": "check-box-outline", "order": 187, "outcomes": [ "Dokumentierte Automatisierungsbereitschaft", "Bekannte Bereitschaftslücken und Gegenmaßnahmen vor der Veröffentlichung", "Nachweise für Qualität, Risiko, Compliance, Aufsicht und betriebliche Freigabe" ], "steps": [ "Prüfen Sie Workflow-Design, Geschäftsregeln, Kontrollen, Zugriff, Datenverarbeitung und Ausnahmewege.", "Überprüfen Sie Testnachweise, Rollback-Verfahren, Überwachungsmodell und Supportbereitschaft.", "Bestätigen Sie Verantwortung, Runbooks, Monitoring, Änderungskontrollen und Veröffentlichungsfreigabe.", "Dokumentieren Sie ungelöste Lücken, Entscheidungen und akzeptierte Risiken vor der Veröffentlichung." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true }, { "id": "automation-rollout-enablement-guide", "slug": "resources/automation-rollout-enablement-guide", "title": "Leitfaden für Rollout und Enablement von Automatisierungen", "description": "Orientierung für die Einführung von Automatisierungen mit Nutzerkommunikation, Onboarding, Betriebsanweisungen, Supportwegen, Change Management und Feedback-Schleifen.", "category": "guideline", "icon": "edit-document-outline", "order": 188, "outcomes": [ "Befähigte Automatisierungsnutzer und Betreiber", "Rollout-Kommunikation, Onboarding und Supportwege vorbereitet", "Nutzer und Betreiber verstehen, wie sich die Arbeit nach der Veröffentlichung der Automatisierung verändert" ], "steps": [ "Definieren Sie Rollout-Zielgruppen, Zeitplan, Kommunikationskanäle und Schulungsbedarf.", "Veröffentlichen Sie Betriebsanweisungen, Supportwege, Hinweise zur Ausnahmebehandlung und Eskalationskontakte.", "Planen Sie Übergangsunterstützung für Nutzer, Betreiber und Prozessverantwortliche.", "Sammeln Sie Feedback nach dem Rollout und überführen Sie Verbesserungen in den Backlog." ], "canvasId": null, "sourcePath": null, "sourceUrl": null, "contentMarkdown": null, "draft": true } ], "criteria": [ { "id": "metrics-feedback-available", "title": "Relevante Marktsignale, Feedback oder operative Erkenntnisse liegen vor, um diese Capability-Möglichkeit zu bewerten.", "description": "Relevant market signals, feedback, or operational insights are available to guide this API opportunity.", "category": "" }, { "id": "business-goals-defined", "title": "Die Geschäftsziele sind definiert.", "description": "Business goals are defined.", "category": "" }, { "id": "market-research-done", "title": "Die Marktrecherche identifiziert relevante Capability-Möglichkeiten.", "description": "Market research identifies API opportunities.", "category": "" }, { "id": "stakeholder-approval", "title": "Die relevanten Stakeholder stimmen zu, dass diese Capability-Möglichkeit weiter untersucht und priorisiert werden sollte.", "description": "Relevant stakeholders agree this API opportunity is worth exploring and prioritizing.", "category": "" }, { "id": "api-opportunity-documented", "title": "Die Capability-Möglichkeit wurde identifiziert und dokumentiert.", "description": "Individual API opportunities are identified and documented.", "category": "" }, { "id": "api-reusability", "title": "Die Capability erfüllt einen klaren Geschäftsbedarf und kann von den vorgesehenen Nutzern wiederverwendet werden.", "description": "The API meets a clear business need and is reusable for multiple API consumers.", "category": "" }, { "id": "hide-backend-discrepancies", "title": "Die gewählte Schnittstelle bietet Nutzern eine angemessene Abstraktion.", "description": "The API is intended to shield consumers from backend complexity and inconsistencies.", "category": "" }, { "id": "value-prop-validated", "title": "Das Wertversprechen der Capability wurde mit Geschäfts- und Nutzer-Stakeholdern validiert.", "description": "The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders.", "category": "" }, { "id": "consumer-segments-identified", "title": "Die Nutzersegmente sind identifiziert.", "description": "API consumer segments (internal and external) are identified.", "category": "" }, { "id": "api-roadmap-defined", "title": "Eine übergeordnete Roadmap für die Umsetzung ist definiert.", "description": "High-level roadmaps for API development are established.", "category": "" }, { "id": "architecture-patterns-validated", "title": "Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.", "description": "The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders.", "category": "" }, { "id": "design-reflects-business-value", "title": "Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.", "description": "The API design and exposed capabilities clearly trace back to business value and user needs.", "category": "" }, { "id": "api-consistency", "title": "Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.", "description": "The API design follows our shared API product and design conventions.", "category": "" }, { "id": "api-contract-tested", "title": "Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.", "description": "The API contract is tested and meets functional and non-functional requirements.", "category": "" }, { "id": "automation-workflow-validated", "title": "Workflow, Regeln, Integrationen und relevante Schnittstellenverträge wurden validiert und getestet.", "description": "The workflow, rules, integrations, and relevant interface contracts have been validated and tested.", "category": "" }, { "id": "api-description-available", "title": "Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.", "description": "The API and its exposed capabilities are described clearly enough for review, audit, and onboarding.", "category": "" }, { "id": "audit-passed", "title": "Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.", "description": "The API passes compliance, security, and audit checks.", "category": "" }, { "id": "audit-reports-shared", "title": "Audit-Ergebnisse und Maßnahmenentscheidungen wurden mit den relevanten Stakeholdern geteilt.", "description": "Audit findings and remediation decisions are shared with the relevant stakeholders.", "category": "" }, { "id": "api-ready-for-publishing", "title": "Die Capability ist bereit, über den gewählten Bereitstellungsmechanismus veröffentlicht oder ausgeliefert zu werden.", "description": "The API is ready to be deployed and exposed through the intended gateways and environments.", "category": "" }, { "id": "api-documentation-ready", "title": "Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.", "description": "Consumer-facing API documentation is complete enough for publishing and onboarding.", "category": "" }, { "id": "consumer-support-ready", "title": "Onboarding-, Support- und Kommunikationsprozesse für Nutzer sind bereit.", "description": "Registration, support, and communication processes are ready for API consumers.", "category": "" }, { "id": "legal-compliance-clear", "title": "Rechtliche, Datenschutz- und Compliance-Anforderungen für Veröffentlichung oder Release sind definiert und verstanden.", "description": "Legal, privacy, and compliance requirements for publishing are defined and understood.", "category": "" } ] } } }