book

RESTful Web Services Cookbook

by Subbu Allamaraju

March 2010

Intermediate to advanced

312 pages

7h 31m

English

O'Reilly Media, Inc.

Read now

Unlock full access

Scope of the BookCompanion MaterialHow This Book Is OrganizedConventions Used in This BookUsing Code ExamplesSafari® Books OnlineHow to Contact UsAcknowledgmentsMike Amundsen’s Contribution
1.1. How to Keep Interactions Visible1.2. When to Trade Visibility1.3. How to Maintain Application State1.4. How to Implement Safe and Idempotent Methods on the Server1.5. How to Treat Safe and Idempotent Methods in Clients1.6. When to Use GET1.7. When to Use POST1.8. How to Create Resources Using POST1.9. When to Use PUT to Create New Resources1.10. How to Use POST for Asynchronous Tasks1.11. How to Use DELETE for Asynchronous Deletion1.12. When to Use Custom HTTP Methods1.13. When and How to Use Custom HTTP Headers
2.1. How to Identify Resources from Domain Nouns2.2. How to Choose Resource Granularity2.3. How to Organize Resources into Collections2.4. When to Combine Resources into Composites2.5. How to Support Computing/Processing Functions2.6. When and How to Use Controllers to Operate on Resources
3.1. How to Use Entity Headers to Annotate Representations3.2. How to Interpret Entity Headers3.3. How to Avoid Character Encoding Mismatch3.4. How to Choose a Representation Format and a Media Type3.5. How to Design XML Representations3.6. How to Design JSON Representations3.7. How to Design Representations of Collections3.8. How to Keep Collections Homogeneous3.9. How to Use Portable Data Formats in Representations3.10. When to Use Entity Identifiers3.11. How to Encode Binary Data in Representations3.12. When and How to Serve HTML Representations3.13. How to Return Errors3.14. How to Treat Errors in Clients
4.1. How to Design URIs4.2. How to Use URIs As Opaque Identifiers4.3. How to Let Clients Treat URIs As Opaque Identifiers4.4. How to Keep URIs Cool
5.1. How to Use Links in XML Representations5.2. How to Use Links in JSON Representations5.3. When and How to Use Link Headers5.4. How to Assign Link Relation Types5.5. How to Use Links to Manage Application Flow5.6. How to Deal with Ephemeral URIs5.7. When and How to Use URI Templates5.8. How to Use Links in Clients
6.1. How to Model Resources Using Atom6.2. When to Use Atom6.3. How to Use AtomPub Service and Category Documents6.4. How to Use AtomPub for Feed and Entry Resources6.5. How to Use Media Resources
7.1. How to Indicate Client Preferences7.2. How to Implement Media Type Negotiation7.3. How to Implement Language Negotiation7.4. How to Implement Character Encoding Negotiation7.5. How to Support Compression7.6. When and How to Send the Vary Header7.7. How to Handle Negotiation Failures7.8. How to Use Agent-Driven Content Negotiation7.9. When to Support Server-Driven Negotiation
8.1. How to Design URIs for Queries8.2. How to Design Query Responses8.3. How to Support Query Requests with Large Inputs8.4. How to Store Queries
9.1. How to Set Expiration Caching Headers9.2. When to Set Expiration Caching Headers9.3. When and How to Use Expiration Headers in Clients9.4. How to Support Caching for Composite Resources9.5. How to Keep Caches Fresh and Warm

10.1. How to Generate Last-Modified and ETag Headers10.2. How to Implement Conditional GET Requests in Servers10.3. How to Submit Conditional GET and HEAD Requests from Clients10.4. How to Implement Conditional PUT Requests in Servers10.5. How to Implement Conditional DELETE Requests in Servers10.6. How to Make Unconditional GET Requests from Clients10.7. How to Submit Conditional PUT and DELETE Requests from Clients10.8. How to Make POST Requests Conditional10.9. How to Generate One-Time URIs
11.1. How to Copy a Resource11.2. How to Merge Resources11.3. How to Move a Resource11.4. When to Use WebDAV Methods11.5. How to Support Operations Across Servers11.6. How to Take Snapshots of Resources11.7. How to Undo Resource Updates11.8. How to Refine Resources for Partial Updates11.9. How to Use the PATCH Method11.10. How to Process Similar Resources in Bulk11.11. How to Trigger Bulk Operations11.12. When to Tunnel Multiple Requests Using POST11.13. How to Support Batch Requests11.14. How to Support Transactions
12.1. How to Use Basic Authentication to Authenticate Clients12.2. How to Use Digest Authentication to Authenticate Clients12.3. How to Use Three-Legged OAuth12.4. How to Use Two-Legged OAuth12.5. How to Deal with Sensitive Information in URIs12.6. How to Maintain the Confidentiality and Integrity of Representations
13.1. How to Maintain URI Compatibility13.2. How to Maintain Compatibility of XML and JSON Representations13.3. How to Extend Atom13.4. How to Maintain Compatibility of Links13.5. How to Implement Clients to Support Extensibility13.6. When to Version13.7. How to Version RESTful Web Services
14.1. How to Document RESTful Web Services14.2. How to Use OPTIONS
BooksReferences
Uniform Resource IdentifiersResourcesRepresentationsUniform InterfaceHypermedia and Application State
OPTIONSGETHEADPOSTPUTDELETETRACE
Key Elements of Feeds and EntriesOther Atom Elements to Consider
alternateappendixbookmarkchapter, section, subsectioncontentscopyrightcurrentdescribedbyeditedit-mediaenclosurefirst, last, next, next-archive, prev, previous, prev-archive, startglossaryhelpindexlicensepaymentrelatedrepliesselfservicestylesheetupvia

Content preview from RESTful Web Services Cookbook

About the Author

Subbu Allamaraju is a Principal Engineer at Yahoo! where, during the last one year, he has been developing standards and practices for designing RESTful Web APIs. Prior to that Subbu developed web services/Java based software and contributed to JCP and OASIS standards at BEA Systems Inc. Subbu has contributed to four books on J2EE, all published by Wrox. For a complete list of his works, and writings, see http://www.subbu.org/about.

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Start your free trial

RESTful Web Services

Leonard Richardson, Sam Ruby

RESTful Web Clients

Mike Amundsen

Service Design Patterns: Fundamental Design Solutions for SOAP/WSDL and RESTful Web Services

Robert Daigneau

How to Break Web Software: Functional and Security Testing of Web Applications and Web Services

James A. Whittaker, Mike Andrews

Publisher Resources

ISBN: 9780596809140Errata Page