-
Notifications
You must be signed in to change notification settings - Fork 152
REST
REpresentational State Transfer (REST) is an architectural style for designing Web Services, which is heavily centered on the notion of "resources" that is core to the World Wide Web.
REST is NOT a standard!
Most often, so-called RESTful Web Services communicate over HTTP and expose resources using Uniform Resource Identifiers (URIs).
RESTful Web Services rely on HTTP semantics and HTTP verbs (e.g., GET, POST, PUT, DELETE, ...).
REST was defined by Roy Fielding in his 2000 PhD dissertation (Architectural Styles and the Design of Network-based Software Architectures). Note that Roy Fielding is one of the main authors of the HTTP specification and the co-founder of the Apache HTTP Server project.
At the core, the main goals of REST are to:
- create loosely coupled applications
- create scalable applications
- create performant applications
- simplify interfaces
To realize these goals, REST defines a set principles and constraints.
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