API Canvas

Use this template to design synchronous APIs

Bounded Context

Find a name for your bounded context

Server

Enter the URL of your server to access the API

Contact

Who to contact when you have questions about the API

Resources

Which resources can be accessed by the API

Sub-resources

Which sub-resource can be accessed by the API

Parameters

Which parameters are necessary to access the resources

Requests

Which data must be delivered in a request

Responses

Which responses are delivered

Security scopes

Which security scopes are necessary

Notes

Document open questions and discussion points