API Product Canvas

API Product Canvas

Use this canvas to design synchronous and asynchronous APIs of abounded context in a workshop.

Name of the bounded context

Version

Version of the API, Events

Contact

Name of the contact, e.g., moderator of the design workshop or the product owner of the bounded context

Sync protocol: e.g. HTTP

Architecture pattern: e.g., RESTful oriented

Server: Base URL of the API server

Aggregates and Entities

Aggregates Operation applied to the aggregates

Aggregate Operation applied to the aggregate.

Entity Operation applied to the entit.y

Parameters:

Parameter belonging to the operation

Requests

Incoming data for an operation

Responses:

Outgoing data of an operation

Async protocol: Kafka

Architecture pattern: event-driven architecture

Server:

URL to the used event broker it remains empty when no broker is used

Events Receive

Domain event happened

Payload

Payload

Events Send

Domain event happened

Payload

Payload

Quality requirements:

• List of quality requirements of the bounded context

Notes

Special notes to the bounded context

Template was created in collaboration with Fabrizio Lazzaretti.