Consistent RESTful API design
REST Canvas
Design APIs using RESTful principles, defining resources, verbs, and example requests and responses.
How it works
Section titled “How it works”See example
Section titled “See example”- Identify key resources exposed by the API
- Define the structure of the API resource model
- Specify HTTP verbs used to interact with resources
- Provide example requests and responses for each verb
- Use standard HTTP methods (GET, POST, PUT, DELETE)
- Ensure resource URIs are intuitive and consistent
- document error handling and response codes
Accelerate Your APIs with APIOps Cycles Workshop
A compact, high-impact 2-hour online or onsite workshop for API product owners, architects, platform teams, and IT leaders.
Learn more