Patterns for API Design: Simplifying Integration with Loosely Coupled Message Exchanges, 1st edition

Published by Addison-Wesley Professional (December 5, 2022) © 2023

  • Olaf Zimmermann
  • Mirko Stocker
  • Daniel Lubke
  • Uwe Zdun
  • Cesare Pautasso
  • Available for purchase from all major ebook resellers, including InformIT.com
Products list
  • Available for purchase from all major ebook resellers, including InformIT.com

Title overview

As thousands of developers focus on constructing reliable, well-performing, and secure APIs, there's immense demand for a practical, up-to-date, technology-and-platform-independent guide to API design. Patterns for API Design: Simplifying Integration with Loosely Coupled Message Exchanges fills this gap. A team of expert authors cut through the complexity of API communication and message content, presenting rich and complete design guidelines and heuristics for engineering APIs sustainably and specifying them clearly.

Patterns for API Design: Simplifying Integration with Loosely Coupled Message Exchanges covers the entire API lifecycle, from launching projects and establishing business goals through defining architecturally significant requirements, elaborating and implementing designs, and documentation. It illuminates patterns drawn from both public web APIs and proprietary application development and software integration projects the authors have led or participated in. You'll find a complete library of concrete, actionable design patterns, each formatted consistently to explain context, forces, problem, solution, discussion, and known uses.

Throughout, the authors share practical insights for making better design decisions and tradeoffs, facilitating easier implementation, and structuring and designing higher-quality APIs to meet both short- and long-term needs. You'll learn how to:

  • Facilitate better API design discussions by establishing a common vocabulary, identifying key decisions, and comparing realistic options
  • Simplify design reviews and accelerate objective comparisons
  • Plan to smoothly evolve and extend APIs without compromising backward-compatibility
  • Enhance documentation with useful design knowledge to help client developers quickly grasp API capabilities and constraints, and confidently use your APIs

Table of contents

  • Part 1: Foundations and Narratives
  • Chapter 1: Application Programming Interface (API) Fundamentals
  • Chapter 2: Lakeside Mutual Case Study
  • Chapter 3: API Decision Narratives
  • Part 2: The Patterns
  • Chapter 4: Pattern Language Introduction
  • Chapter 5: Define Endpoint Types and Operations
  • Chapter 6: Design Request and Response Message Representations
  • Chapter 7: Refine Message Design for Quality
  • Chapter 8: Evolve APIs
  • Chapter 9: Document and Communicate API Contracts
  • Part 3: Our Patterns in Action (Now and Then)
  • Chapter 10: Real-World Pattern Stories
  • Chapter 11: Conclusion
  • Appendix A: Endpoint Identification and Pattern Selection Guides
  • Appendix B: Implementation of the Lakeside Mutual Case
  • Appendix C: Microservice Domain-Specific Language (MDSL)

Author bios

This publication contains markup to enable structural navigation and compatibility with assistive technologies. Images in the publication are fully described. The publication supports text reflow, is screen-reader friendly, and contains no content hazards known to cause adverse physical reactions.

Need help?Get in touch