canvas

REST Canvas

Design APIs using RESTful principles, defining resources, verbs, and example requests and responses.

Outcomes

  • Consistent RESTful API design
  • Defined resources and their interactions
  • Example requests and responses for clarity

How it works

  1. Identify key resources exposed by the API
  2. Define the structure of the API resource model
  3. Specify HTTP verbs used to interact with resources
  4. Provide example requests and responses for each verb

Work with this canvas

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

Local canvas workspace

REST Canvas

How can the API be designed using RESTful principles? Define the API resources, verbs, and example requests and responses.

Active section: API Resources. Select a section with a pointer, or focus it and press Enter or Space.

API Resources

What are the key resources exposed by the API?

API Resource Model

What is the structure of the API resource model?

API Verbs

What HTTP verbs are used to interact with the API resources?

API Verb Example

Provide an example of an API request and response for each verb.

Canvas metadata

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

Related stations