Design Notes

• Application is computerized behavior to achieve a business goal
• Application Protocol is a set of rules of allowed/legal interactions in an Application
• Application State is an instant of time of the Application
• URIs are used for resource identification
• HTTP Methods/Verbs are used as the Uniform Interface
• Resources are a logical representation of the Domain Model/Data Set
• Resource Representations are transformations/views of Resources state at an instant of time
• Resource Representations are requested via headers
• There is a one to many relationship between a resource and its representations
• Access to Resources is always mediated by way of Resource Representations
• Hypermedia Resource Representation allows lazy-cacheable access that advertise permitted transitions
• Use Transaction Resources to create stateless interaction

Design Procedure

1. Figure out the Domain Model/Data Set (if it does not already exists)
2. Split the Domain Model/Data Set into logical Resources
3. Name the resources using URIs i.e. /orders, /orders/{key}, etc.
4. Expose your subset of the uniform interface i.e. GET/POST/PUT/DELETE
5. Design the Resource Representations
6. Design the Hypermedia Resource Representations integration
7. Design Scenarios, Alternative Paths & Error Conditions