-
Notifications
You must be signed in to change notification settings - Fork 152
REST API Design Goals
Whenever you design a REST API, you should strive for:
- simplicity and ease of use
- be friendly to consumers of your API: try to make their life easier and less painful
- focus on URIs and payloads: these are what your clients will have to live with, not your internal domain model
- do not apply the SOAP-way when you create RESTful APIs, the clients are not the same (humans vs machines)
- your API should be easily explorable through a standard Web browser
- consistency
- aim for consistency across your API
- do not implement similar things in different ways (e.g., never implement search or filtering in different manners)
- flexibility
- empower the clients of your API
- although, try to keep things simple unless there's no alternative
This project is distributed under the terms of the EUPL FOSS license
REST Resources Design Workflow
REST Resources Single items and collections
REST Resources Many to many Relations
REST Resources Relations expansion
HTTP Status Codes Success (2xx)
HTTP Status Codes Redirection (3xx)
HTTP Status Codes Client Error (4xx)
HTTP Status Codes Server Error (5xx)
Pagination Out of range/bounds
Long-running Operations Example
Concurrency vs Delete operation
Caching and conditional requests About
Caching and conditional requests Rules
Caching and conditional requests HTTP headers
Error handling Example with a single error
Error handling Example with multiple errors
Error handling Example with parameters
Error handling Example with additional metadata
Bulk operations HTTP status codes
Bulk operations Resources naming convention
Bulk operations Creation example
Bulk operations Update example
Bulk operations Create and update example
File upload Simple file upload
File upload Simple file upload example
File upload Complex file upload
File upload Complex file upload example
REST Security General recommendations
REST Security Insecure direct object references