The Design of Web APIs, Second Edition

Learn how to design web APIs that are a delight to use and maintain.Thousands of developers have followed renowned API expert Arnaud Lauret’s guidance to create APIs that are flexible, secure, and easily integrated. This new edition of the bestselling The Design of Web APIs covers the latest updates to the OpenAPI standard, teaches you to streamline and standardize API design decisions with rationale and automation, and gives you insights you can apply to other API styles, such as gRPC. You’ll quickly see how a well-designed and properly-documented API gives your users autonomy—and saves you from constant explanations and hand-holding.This fully revised second edition of The Design of Web APIs teaches you the principles and techniques you need to design easy-to-consume public and private web APIs. In it, you’ll learn how to:Analyze requirements to identify API capabilities for versatile, reusable designsCreate HTTP-based REST APIs with CRUD, batch/bulk, or long operationsDesign interoperable, user-friendly APIs with seamless operations and data flowEnsure secure, efficient APIs while overcoming limitations and constraintsModify APIs without breaking compatibility, evaluating consequences carefullyFuture-proof your APIs and choose effective versioning strategiesDocument REST APIs using OpenAPI and JSON Schema for seamless implementationStreamline and standardize API design decisions with rationale and automationThe Design of Web APIs, Second Edition teaches vital skills for gathering requirements, balancing business and technical goals and constraints, and adopting a consumer-first mindset. Each chapter is packed full of hands-on examples, including designing an Online Shopping API and user-friendly banking operations, and over seventy exercises to help your new skills stick. Plus, you’ll explore paradigms applicable beyond REST APIs, and fully describe and document your APIs with OpenAPI and JSON Schema. Your web APIs will soon be easier to consume and your clients—internal and external—will be happier than ever!About the technologyWeb APIs open up your software to developers, exposing features, and capabilities to other programs. Well-designed web APIs are a joy. The bad ones are a nightmare, with endless impact on system performance, developer productivity, and end-user experience. This book shows you how to design APIs your fellow developers will love to use.About the bookThe Design of Web APIs, Second Edition teaches you to design efficient and adaptable REST APIs. This revised and rewritten second edition contains the latest updates to the OpenAPI standard, along with insights you can apply to other API styles such as GraphQL. Learn vital skills for gathering requirements, creating easy-to-consume public and private web APIs, and handling non-backward compatible modifications and versioning.What's insideDesign reusable, user-friendly and interoperable APIsDocument your APIs with OpenAPI and JSON SchemaCreate secure and efficient APIs by designStreamline and standardize API design decisionsAbout the readerWritten for developers with experience building and consuming APIs.About the authorArnaud Lauret runs the API Handyman blog and is a frequent speaker at API conferences. He currently works as an API Industry Researcher at Postman.Table of Contents1 What is API design?Part 12 Identifying API capabilities3 Observing operations from the REST angle4 Representing operations with HTTP5 Modeling data6 Describing HTTP operations with OpenAPI7 Describing data with JSON Schema in OpenAPIPart 28 Designing user-friendly, interoperable data9 Designing user-friendly, interoperable operations10 Designing user-friendly, interoperable operation flows11 Designing user-friendly, interoperable APIsPart 312 Designing a secure API13 Designing an efficient API14 Adapting the API design to the context15 Modifying an APIPart 416 Facilitating API design decision-making17 Optimizing an OpenAPI document18 Automating API design guidelines19 Enriching API design artifactsA Solutions to the exercises

Sdílet