Personnes à impliquer

Designer API

Conçoit le contrat d’interface, le modèle d’interaction, la cohérence et l’utilisabilité des capacités exposées.

Relevant cycles

Cycle d’automatisation

Cycle pour identifier, concevoir, livrer, enable et améliorer des opportunités d’automatisation.

Relevant stations

  • Conception de solution & d'interface

    Concevez le mode de mise en œuvre choisi, le contrat d'interface, les modèles d'interaction, les structures de données et les détails d'utilisation avant l'implémentation.

  • Mise à disposition & opérations

    Mettez en œuvre le mode choisi avec des pratiques adaptées d'ingénierie, de test, de sécurité, d'automatisation et d'exploitation.

  • Assurance qualité & préparation

    Vérifiez le contrat d'interface, les contrôles, le modèle de support, l'observabilité, la documentation et la préparation du cycle de vie avant publication.

  • Exigences utilisateurs & onboarding

    Capturez les exigences des utilisateurs, l'onboarding, les standards, les exigences non fonctionnelles, les attentes de service, les contraintes, la sécurité, les protocoles, la fraîcheur des données, les SLA, l'observabilité, la reprise, l'adoption et les responsabilités des fournisseurs.

Decisions and outputs

Decisions

  • Clarifiez les objets métier, les termes, les règles et les responsabilités avant de concevoir le contrat d'interface.
  • Utilisez le canevas d'interaction pour définir la manière dont les utilisateurs interagiront avec l'API, en veillant à ce qu'elle réponde à leurs besoins et à leurs attentes.
  • Appliquer les modèles de conception REST pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
  • Appliquer des modèles de conception orientés événements pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
  • Appliquer les modèles de conception GraphQL pour créer des contrats d'interface cohérents et réutilisables qui sont validés avec les parties prenantes.
  • Utiliser les principes de conception et le guide de style des API pour aligner vos décisions de conception sur des règles communes et permettre une validation d'audit cohérente.

Outputs

  • Un contrat d'interface validé pour le mode de mise en œuvre choisi
  • Contrats d'interface réutilisables et validés
  • Conceptions alignées sur les modèles de domaine et les modèles d'interaction
  • Traçabilité de la conception à la valeur métier
  • spec
  • contract
  • design-artifact
  • documentation

Recommended resources

Facilitate as Designer API

Use these prepared prompts alongside the stakeholder decisions, outputs, stations, and resources summarized above.

Utiliser avec l'IA

Faciliter la discussion de station

Facilitate a station with Designer API

facilitate-station

Stakeholder: Designer API
Cycles: Cycle de productisation des capacités, Cycle de productisation des API, Cycle de productisation des capacités d’intégration, Cycle d’automatisation
Stations: Conception de solution & d'interface, Mise à disposition & opérations, Assurance qualité & préparation, Exigences utilisateurs & onboarding
Resources and canvases: Domain Canvas, Interaction Canvas, Consumer Experience Requirements Canvas, REST Canvas, Event Canvas, GraphQL Canvas, API Value Proposition Canvas, Customer Journey Canvas

Act as an APIOps Cycles facilitator. Use the selected station questions, entry criteria, exit criteria, stakeholders, and related resources to guide the discussion. Produce decisions, evidence gaps, and next steps.