API Design Patterns
JJ Geewax
  • MEAP began June 2019
  • Publication in Summer 2020 (estimated)
  • ISBN 9781617295850
  • 375 pages (estimated)
  • printed in black & white
Modern software systems are composed of many servers, services, and other components that communicate through APIs. As a developer, your job is to make sure these APIs are stable, reliable, and easy to use for other developers. API Design Patterns provides you with a unique catalog of design standards and best practices to ensure your APIs are flexible and user-friendly. Fully illustrated with examples and relevant use-cases, this essential guide covers patterns for API fundamentals and real-world system designs, along with quite a few not-so-common scenarios and edge-cases.
Table of Contents detailed table of contents

1 Introduction to APIs

1.1 What are interfaces?

1.2 What are APIs?

1.3 Why do APIs matter?

1.4 What are resource-oriented APIs?

1.5 What makes an API “good”?

1.5.1 Operational

1.5.2 Expressive

1.5.3 Simple

1.5.4 Predictable

1.6 Summary

2 Introduction to API design patterns

2.1 What are API design patterns?

2.2 Why are API design patterns important?

2.3 Anatomy of an API design pattern

2.3.1 Name and synopsis

2.3.2 Motivation

2.3.3 Overview

2.3.4 Implementation

2.3.5 Trade-offs

2.4 Case study: Twapi a Twitter-like API

2.4.1 Overview

2.4.2 Listing messages

2.4.3 Exporting data

2.5 Summary

3 General design principles

4 Resource layout

4.1 Singleton sub-resources

4.1.1 Motivation

4.1.2 Overview

4.1.3 Implementation

4.1.4 Trade-offs

4.2 Cross references

4.2.1 Motivation

4.2.2 Overview

4.2.3 Implementation

4.2.4 Trade-offs

4.3 Association resources

4.3.1 Motivation

4.3.2 Overview

4.3.3 Implementation

4.3.4 Trade-offs

4.3.5 Exercises

4.3.6 Summary

4.4 Add and remove custom methods

4.4.1 Motivation

4.4.2 Overview

4.4.3 Implementation

4.4.4 Trade-offs

5 Basic interactions

6 Special interactions

7 Data exploration and transformation

8 Enterprise

9 Conclusion

10 Glossary

About the Technology

API design patterns are a useful set of best practice specifications and common solutions to API design challenges. Using accepted design patterns creates a shared language amongst developers who create and consume APIs, which is especially critical given the explosion of mission-critical public-facing web APIs. API Patterns are still being developed and discovered. This collection, gathered and tested by Google API expert JJ Geewax, is the first of its kind.

About the book

API Design Patterns draws on the collected wisdom of the API community, including the internal developer knowledge base at Google, laying out an innovative set of design patterns for developing both internal and public-facing APIs. In this essential guide, Google Software Engineer JJ Geewax provides a unique and authoritative catalog of patterns that promote flexibility and ease-of-use in your APIs. Each pattern in the catalog is fully illustrated with its own example API, use-cases for solving common API design challenges, and scenarios for tricky edge issues using a pattern’s more subtle features. With the best practices laid out in this book, you can ensure your APIs are adaptive in the face of change and easy for your clients to incorporate into their projects.

What's inside

  • A full case-study of building an API and adding features
  • The guiding principles that underpin most API patterns
  • Fundamental patterns for resource layout and naming
  • Advanced patterns for special interactions and data transformations

About the reader

Aimed at software developers with experience using APIs, who want to start building their own.

About the author

JJ Geewax is a software engineer at Google, focusing on Google Cloud Platform and API design. He is also the author of Google Cloud Platform in Action.

Manning Early Access Program (MEAP) Read chapters as they are written, get the finished eBook as soon as it’s ready, and receive the pBook long before it's in bookstores.
MEAP combo
...
$35.00 $49.99 pBook + eBook + liveBook
MEAP eBook
...
$25.00 $39.99 pdf + ePub + kindle + liveBook

placing your order...

Don't refresh or navigate away from the page.

FREE domestic shipping on three or more pBooks