طراحی APIهای وب: راهنمایی برای ساخت APIهایی که استفاده و نگهداری از آن‌ها لذت‌بخش است.

هزاران توسعه‌دهنده با بهره‌گیری از راهنمایی‌های آرنود لورِه (Arnaud Lauret) – متخصص شناخته‌شده در حوزه طراحی API – موفق شده‌اند APIهایی طراحی کنند که انعطاف‌پذیر، ایمن، و به‌راحتی قابل‌ادغام باشند. این نسخه جدید از کتاب پرفروش The Design of Web APIs با پوشش آخرین تغییرات استاندارد OpenAPI، به شما می‌آموزد که چگونه فرآیند تصمیم‌گیری در طراحی API را استانداردسازی و خودکارسازی کنید، و چگونه این مهارت‌ها را در سایر سبک‌های API مانند gRPC نیز به‌کار ببرید.

در این ویرایش دوم که به‌طور کامل بازنویسی و به‌روزرسانی شده، شما با اصول و تکنیک‌های طراحی APIهایی آشنا می‌شوید که قابل‌استفاده، خوش‌ساخت و مستندسازی‌شده هستند؛ APIهایی که باعث خودمختاری مصرف‌کننده می‌شوند و شما را از پاسخ‌گویی مداوم و توضیح‌های تکراری نجات می‌دهند.

در این کتاب می‌آموزید:

• تحلیل نیازمندی‌ها برای شناسایی قابلیت‌های موردنیاز API و خلق طراحی‌های قابل‌استفاده مجدد و منعطف
• طراحی RESTful APIها با عملیات CRUD، درخواست‌های دسته‌ای (batch/bulk) و عملیات زمان‌بر
• ایجاد APIهایی که سازگار و کاربرپسند هستند، با جریان داده و عملیات روان
• طراحی APIهای ایمن و بهینه با در نظر گرفتن محدودیت‌ها و چالش‌های فنی
• تغییر در API بدون شکستن سازگاری (backward compatibility) و بررسی پیامدهای آن
• آینده‌نگری در طراحی و انتخاب استراتژی‌های مؤثر برای نسخه‌بندی (API versioning)
• مستندسازی APIها با استفاده از OpenAPI و JSON Schema
• استانداردسازی تصمیمات طراحی API با منطق شفاف و ابزارهای خودکارسازی

درباره‌ی این کتاب:

کتاب The Design of Web APIs – Second Edition مهارت‌هایی حیاتی برای جمع‌آوری نیازمندی‌ها، موازنه میان اهداف تجاری و محدودیت‌های فنی، و در اولویت قرار دادن تجربه توسعه‌دهنده‌ی مصرف‌کننده (consumer-first) را به شما می‌آموزد.

هر فصل همراه با مثال‌های عملی از جمله طراحی یک API فروشگاه آنلاین و عملیات بانکی کاربرپسند است. بیش از ۷۰ تمرین نیز برای تثبیت یادگیری در نظر گرفته شده است. علاوه بر REST، مفاهیم این کتاب در سبک‌هایی مانند GraphQL و gRPC نیز کاربرد دارند.

درباره فناوری API:

وب‌APIها به نرم‌افزار شما این امکان را می‌دهند که با سایر برنامه‌ها تعامل داشته باشد و امکانات خود را در اختیار توسعه‌دهندگان دیگر قرار دهد. APIهای خوش‌ساخت، استفاده‌پذیری بالا دارند؛ اما طراحی ضعیف آن‌ها می‌تواند منجر به عملکرد ضعیف، سردرگمی توسعه‌دهنده‌ها و تجربه کاربری نامطلوب شود. این کتاب نشان می‌دهد چگونه می‌توانید APIهایی طراحی کنید که توسعه‌دهنده‌ها عاشق‌شان شوند.

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 designs

• Create HTTP-based REST APIs with CRUD, batch/bulk, or long operations

• Design interoperable, user-friendly APIs with seamless operations and data flow

• Ensure secure, efficient APIs while overcoming limitations and constraints

• Modify APIs without breaking compatibility, evaluating consequences carefully

• Future-proof your APIs and choose effective versioning strategies

• Document REST APIs using OpenAPI and JSON Schema for seamless implementation

• Streamline and standardize API design decisions with rationale and automation

The 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 technology

Web 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 book

The 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 inside

• Design reusable, user-friendly and interoperable APIs

• Document your APIs with OpenAPI and JSON Schema

• Create secure and efficient APIs by design

• Streamline and standardize API design decisions

About the reader

Written for developers with experience building and consuming APIs.

Table of Contents

1. What is API design?

Part 1. Fundamentals of API design

2. Identifying API capabilities

3. Observing operations from the REST angle

4. Representing operations with HTTP

5. Modeling data

6. Describing HTTP operations with OpenAPI

7. Describing data with JSON Schema in OpenAPI

Part 2. User-friendly, interoperable API design

8. Designing user-friendly, interoperable data

9. Designing user-friendly, interoperable operations

10. Designing user-friendly, interoperable operation flows

11. Designing user-friendly, interoperable APIs

Part 3. Constrained API design

12. Designing a secure API

13. Designing an efficient API

14. Adapting the API design to the context

15. Modifying an API

Part 4. Scaled and simplified API design

16. Facilitating API design decision-making

17. Optimizing an OpenAPI document

18. Automating API design guidelines

19. Enriching API design artifacts

A. Solutions to the exercises

About the Author

Arnaud Lauret is a software architect with 15 years of experience in the banking industry. He has spent a decade using, designing, and building APIs. He's known on the web as the API Handyman (http: //apihandyman.io) and is the creator of the API Stylebook (http: //apistylebook.com), a collection of resources for API designers.