Skip to Main Content
Patterns for API Design: Simplifying Integration with Loosely Coupled Message Exchanges
book

Patterns for API Design: Simplifying Integration with Loosely Coupled Message Exchanges

by Olaf Zimmermann, Mirko Stocker, Daniel Lubke, Uwe Zdun, Cesare Pautasso
November 2022
Intermediate to advanced content levelIntermediate to advanced
544 pages
15h 47m
English
Addison-Wesley Professional
Content preview from Patterns for API Design: Simplifying Integration with Loosely Coupled Message Exchanges

Chapter 9

Document and Communicate API Contracts

This final chapter of Part 2 collects patterns for capturing technical API specifications and sharing them with client developers and other stakeholders. We also cover business aspects that API product owners are concerned with, including pricing and usage constraints. Documenting software engineering artifacts might not be a popular task, but it is key to promoting API interoperability and understandability. Charging for API usage and limiting resource usage protects the current and future health of an API. Failing to do so might not cause any major problems in the short term (depending on the API status and criticality), but it increases business and technical risk, possibly harming the success ...

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

You might also like

Patterns of Enterprise Application Architecture

Patterns of Enterprise Application Architecture

Martin Fowler
Microservices Patterns

Microservices Patterns

Chris Richardson
Mastering API Architecture

Mastering API Architecture

James Gough, Daniel Bryant, Matthew Auburn

Publisher Resources

ISBN: 9780137670093