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 ...

Get Patterns for API Design: Simplifying Integration with Loosely Coupled Message Exchanges now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.