Learn how to build robust, future-proof APIs by applying the latest industry best practices, avoiding common pitfalls, and understanding anti-patterns
Free with your book: DRM-free PDF version + access to Packt's next-gen Reader*
Key Features
- Design APIs with your audience in mind to improve usability, lifecycle management, and communication
- Learn how to create a client-centric REST API design leveraging OpenAPI and JSON Schema
- Explore API versioning strategies, and gain hands-on experience with API testing and implementation
- Purchase of the print or Kindle book includes a free PDF eBook
Book Description
Designing scalable, user-focused, and robust APIs that last isn’t just a technical challenge but a design imperative. Written by API leaders with over 30 years of combined experience in API strategy, governance, and community, this book is your comprehensive guide to API design, focusing on domain-driven, consumer-centric APIs that meet real user needs while remaining flexible and maintainable over time. It covers modern REST API design, tools like OpenAPI and JSON Schema, and the importance of a product-based approach. The chapters help you explore best practices, potential pitfalls, and anti-patterns, extending beyond the design phase.
Starting with the “why” behind building an API, its intended users, and value, this book walks you through the API lifecycle, the role of contracts, and applying domain-driven design. You’ll develop a solid foundation in REST API design as you discover different styles, constraints, and more. Beyond design, the book covers testing techniques, API evolution, maintenance, and deprecation.
By the end, you’ll not only know how to design great APIs but understand how to treat them as products, manage their lifecycle, and deliver real value by keeping your APIs relevant and reliable long after release.
*Email sign-up and proof of purchase required
What you will learn
- Assess your client's needs to design APIs that communicate the value of your product
- Understand the role of API lifecycle and the importance of contracts
- Apply domain-driven design principles in API architecture
- Embrace a modern approach to REST API design
- Use the OpenAPI Specification and JSON Schema for standardized APIs
- Evolve, maintain, and deprecate your APIs without disrupting your users
Who this book is for
This book is for professionals involved in the digital product lifecycle who want to deepen their understanding of API design and build future-proof APIs with a product-centric approach. API developers, solution architects and engineers, technical product owners, and software architects looking to extend their skills in creating efficient, scalable, and maintainable APIs will find this book particularly useful. Basic knowledge of APIs and the HTTP protocol is recommended to fully benefit from the design principles and practices covered.
Table of Contents
- The “Why” of API Development
- API as a Product: Designing APIs with a Product Mindset
- Understanding Application and API Lifecycles
- Applying Domain-Driven Design to APIs
- Comparing and Choosing the Right API Style
- REST Design Constraints and Maturity Models
- Constructing an API Design Domain Model
- Designing and Managing Effective API Contracts
- Understanding the OpenAPI Specification
- OpenAPI as a Contract: Best Practices and Implementation
- Using JSON Schema to Define Your Object Models
- Don't Hate Your Hypermedia: Creating APIs For Humans and AIs
- API Change Management: Strategies for Versioning and Evolution
Andrzej Jarzyna has spent over 14 years navigating the API landscape, from the early days at 3scale helping clients shape their API strategies to his current role as Chief API Architect at PZU, where he's building an API governance program from the ground up. Along the way, he's tackled everything from designing health research platforms in Mozambique to leading API excellence initiatives at Adidas and spearheading policy-as-code approaches at ING Bank. When he's not deep in OpenAPI specifications or mentoring teams on API design, you'll find him organizing API events, because apparently talking about APIs all day isn't enough. He's also co-founded gaming startup Timewarp Inc and somehow finds time to escape the digital world through climbing and mountaineering adventures.
Samir Amzani is a Principal API Consultant and strategic advisor who specializes in transforming how organizations design, scale, and govern their API ecosystems. Currently serving on the leadership team at Apideck, he drives the evolution of unified API platforms that seamlessly connect thousands of applications. As a Technical Steering Committee member at AsyncAPI, Samir helps shape the future of open standards for event-driven architectures. Over 18 years, he has partnered with industry leaders across diverse sectors, from tech giants like Postman to consumer brands such as Adidas and Back Market, guiding their API transformation journeys from fragmented systems to cohesive, developer-first platforms. His expertise spans the full spectrum of API lifecycle management, from initial strategy through implementation and governance at scale. When Samir steps away from architecting the digital backbone of modern businesses, he finds inspiration in philosophy and travel, pursuits that fuel his ability to see complex technical challenges from fresh perspectives and understand the human stories behind the systems he builds.
