canvas

Interaction Canvas

Définir les interactions API, les flux de travail et les réponses attendues afin de garantir une expérience cohérente pour les consommateurs d'API.

Résultats

  • Modèle d’interaction défini pour la capacité choisie
  • Entrées, sorties, commandes, requêtes, événements et réponses clarifiés
  • Règles de validation et attentes d’interaction convenues

Comment cela fonctionne-t-il ?

  1. Associer les interactions de l'API aux tâches de l'utilisateur
  2. Définir des points finaux pour chaque interaction
  3. Documentez les entrées et les sorties de chaque interaction.
  4. Spécifier les règles et contraintes de validation
  5. Créer des modèles d'interaction pour les interactions CRUD, axées sur les requêtes, axées sur les commandes et axées sur les événements.

Espace canvas local

Use the purpose, outcomes, and instructions above as your static reference while capturing evidence in the interactive workspace.

Espace canvas local

Interaction Canvas

Quels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ? Identifier les styles d’interaction réellement nécessaires et ceux qui sont hors périmètre. Utiliser ce canvas pour clarifier l’intention avant de mapper le résultat vers REST, événements ou GraphQL.

Section active: Interactions CRUD. Sélectionnez une section avec le pointeur, ou placez-y le focus et appuyez sur Entrée ou Espace.

Interactions CRUD

Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?

Modèles d'entrée et de sortie CRUD

Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?

Traitement et validation CRUD

QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?

Interactions pilotées par requêtes

Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?

Modèles d'entrée et de sortie pilotés par les requêtes

Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?

Traitement et validation pilotés par les requêtes

Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?

Interactions pilotées par commandes

Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?

Modèles d'entrée et de sortie pilotés par commande

Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?

Traitement et validation pilotés par les commandes

Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?

Interactions pilotées par les événements

Quels événements doivent être publiés ou consommés, le cas échéant ?

Modèles d'entrée et de sortie pilotés par les événements

Modèles d'entrée et de sortie pilotés par les événements

Traitement et validation pilotés par les événements

Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?

Canvas metadata

APIOps Cycles · CC-BY-SA 4.0 · Osaango Ltd

Related 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.