book

RESTful Web API Patterns and Practices Cookbook

by Mike Amundsen

October 2022

Intermediate to advanced

468 pages

11h 36m

English

O'Reilly Media, Inc.

Book available

Read now

Unlock full access

About This BookConventions Used in This BookUsing Code ExamplesO’Reilly Online LearningHow to Contact UsAcknowledgments
What Are RESTful Web APIs?Why Hypermedia?Shared Principles for Scalable Services on the Web
Establishing a Foundation with Hypermedia DesignsIncreasing Resilience with Hypermedia ClientsPromoting Stability and Modifiability with Hypermedia ServicesSupporting Distributed DataEmpowering Extensibility with Hypermedia Workflow
3.1. Creating Interoperability with Registered Media Types3.2. Ensuring Future Compatibility with Structured Media Types3.3. Sharing Domain Specifics via Published Vocabularies3.4. Describing Problem Spaces with Semantic Profiles3.5. Expressing Actions at Runtime with Embedded Hypermedia3.6. Designing Consistent Data Writes with Idempotent Actions3.7. Enabling Interoperability with Inter-Service State Transfers3.8. Designing for Repeatable Actions3.9. Designing for Reversible Actions3.10. Designing for Extensible Messages3.11. Designing for Modifiable Interfaces
4.1. Limiting the Use of Hardcoded URLs4.2. Coding Clients to Be HTTP Aware4.3. Coding Resilient Clients with Message-Centric Implementations4.4. Coding Effective Clients to Understand Vocabulary Profiles4.5. Negotiating for Profile Support at Runtime4.6. Managing Representation Formats at Runtime4.7. Using Schema Documents as a Source of Message Metadata4.8. Every Important Element Within a Response Needs an Identifier4.9. Relying on Hypermedia Controls in the Response4.10. Supporting Links and Forms for Nonhypermedia Services4.11. Validating Data Properties at Runtime4.12. Using Document Schemas to Validate Outgoing Messages4.13. Using Document Queries to Validate Incoming Messages4.14. Validating Incoming Data4.15. Maintaining Your Own State4.16. Having a Goal in Mind
5.1. Publishing at Least One Stable URL5.2. Preventing Internal Model Leaks5.3. Converting Internal Models to External Messages5.4. Expressing Internal Functions as External Actions5.5. Advertising Support for Client Response Preferences5.6. Supporting HTTP Content Negotiation5.7. Publishing Complete Vocabularies for Machine Clients5.8. Supporting Shared Vocabularies in Standard Formats5.9. Publishing Service Definition Documents5.10. Publishing API Metadata5.11. Supporting Service Health Monitoring5.12. Standardizing Error Reporting5.13. Improving Service Discoverability with a Runtime Service Registry5.14. Increasing Throughput with Client-Supplied Identifiers5.15. Improving Reliability with Idempotent Create5.16. Providing Runtime Fallbacks for Dependent Services5.17. Using Semantic Proxies to Access Noncompliant Services
6.1. Hiding Your Data Storage Internals6.2. Making All Changes Idempotent6.3. Hiding Data Relationships for External Actions6.4. Leveraging HTTP URLs to Support “Contains” and “AND” Queries6.5. Returning Metadata for Query Responses6.6. Returning HTTP 200 Versus HTTP 400 for Data-Centric Queries6.7. Using Media Types for Data Queries6.8. Ignoring Unknown Data Fields6.9. Improving Performance with Caching Directives6.10. Modifying Data Models in Production6.11. Extending Remote Data Stores6.12. Limiting Large-Scale Responses6.13. Using Pass-Through Proxies for Data Exchange

7.1. Designing Workflow-Compliant Services7.2. Supporting Shared State for Workflows7.3. Describing Workflow as Code7.4. Describing Workflow as DSL7.5. Describing Workflow as Documents7.6. Supporting RESTful Job Control Language7.7. Exposing a Progress Resource for Your Workflows7.8. Returning All Related Actions7.9. Returning Most Recently Used Resources7.10. Supporting Stateful Work in Progress7.11. Enabling Standard List Navigation7.12. Supporting Partial Form Submit7.13. Using State-Watch to Enable Client-Driven Workflow7.14. Optimizing Queries with Stored Replays7.15. Synchronous Reply for Incomplete Work with 202 Accepted7.16. Short-Term Fixes with Automatic Retries7.17. Supporting Local Undo or Rollback7.18. Calling for Help7.19. Scaling Workflow with Queues and Clusters7.20. Using Workflow Proxies to Enlist Noncompliant Services
Applying These RecipesTransforming Existing ServicesAdditional ResourcesNext Steps
Viable Registered Media Types for RESTful Web APIsAPI Definition FormatsSemantic Profile Document FormatsHypermedia Supporting Types
Hello, Hyper!Other Information

Content preview from RESTful Web API Patterns and Practices Cookbook

Appendix B. Additional Reading

Here is a list of reading materials that I keep handy on my (virtual) bookshelf. Most of the ones listed here were mentioned somewhere in the book:

Alexander, Christopher. A Pattern Language. New York: Oxford University Press, 1977.
Alexander, Christopher. The Timeless Way of Building. New York: Oxford University Press, 1979.
Amundsen, Mike. Building Hypermedia Clients with HTML5 and Node. Sebastapol, CA: O’Reilly Media, Inc., 2011.
Amundsen, Mike. Design and Build Great Web APIs. Raleigh, NC: Pragmatic Bookshelf, 2020.
Amundsen, Mike. RESTful Web Clients. Sebastapol, CA: O’Reilly Media, Inc., 2017.
Amundsen, Mike. What Is Serverless? Sebastapol, CA: O’Reilly Media, Inc., 2020.
Amundsen, Mike, and Derric Gillig. API Strategy for Decision-Makers. Sebastapol, CA: O’Reilly Media, Inc., 2022.
Bardini, Thierry. Bootstrapping. Stanford, CA: Stanford University Press, 2000.
Bass, Len, et al. Software Architecture in Practice, 4th Edition. Boston: Addison-Wesley, 2021.
Berners-Lee, Tim, and Mark Fishetti. Weaving the Web. New York: Harper-Collins, 2008.
Evans, Eric. Domain-Driven Design. Sebastapol, CA: O’Reilly Media, Inc., 2003.
Gibson, James J. The Ecological Approach to Visual Perception. New York: Psychology Press, 1979.
Gibson, James J. The Senses Considered as Perceptual Systems. Boston: Houghton Mifflin, 1966.
Hall, Wendy, et al. Rethinking Hypermedia. New York: Springer US, 1996.
Higginbotham, James. Principles of Web ...