Automating API Delivery

📘 کتاب Automating API Delivery بهت نشون میده چطور با اعمال اصول اتوماسیون DevOps روی طراحی و پروسه تحویل API، یه تعادل عالی بین سرعت و کاربردی بودن ایجاد کنی. این کتاب یه مسیر شفاف رو جلوی پات میذاره تا تغییرات سازمانی و فنی لازم رو انجام بدی و بتونی APIهای باکیفیت رو هم سریع و هم مطمئن تحویل بدی.

🎯 آنچه یاد خواهید گرفت

در کتاب Automating API Delivery یاد میگیری چطور:

• استانداردهای طراحی API رو با لینتینگ (Linting) اجباری کنی

• چک کردن تغییرات مخرب (Breaking changes) رو اتوماتیک کنی تا جلوی تغییرات بی‌رویه طراحی گرفته بشه

• از دقت مستندات مرجع API مطمئن بشی

• بررسی‌های یکپارچگی تعریف API رو متمرکز کنی • دیپلوی تنظیمات API رو اتوماتیک کنی

• جلسات بررسی طراحی API رو به شکل موثر برگزار کنی

نویسنده، ایکنا نوایوو، راهنمایی‌های جامعی رو برای پیاده‌سازی APIOps توی سازمانت ارائه میده. اون با دقت مراحل فنی رو توضیح میده و ابزارهای متن‌باز (Open-source) ضروری رو همراه با توصیه‌های عملی و بینش‌هایی که از سال‌ها تجربش به دست اومده، معرفی میکنه. نکته‌های شخصی اون برای دوری از تله‌ها و چالش‌های رایج در مسیر اتوماتیک کردن تحویل API خیلی به دردت میخوره. پیشگفتار توسط ملیسا ون در هکت.

🛠 درباره تکنولوژی

با اتوماتیک کردن پروسه توسعه، APIهای باکیفیت، یکپارچه و سریع بساز! این کتاب نوآورانه بهت یاد میده چطور اصول تثبیت‌شده Continuous Delivery و DevOps رو در کل چرخه حیات API پیاده کنی و مجموعه‌ای از تسک‌های جدا از هم رو به یه پایپ‌لاین روان و قابل مدیریت تبدیل کنی که از تست اتوماتیک، بهبود تکرارپذیر (Iterative) و داکیومنتیشن قابل اطمینان پشتیبانی میکنه.

📚 درباره کتاب

کتاب Automating API Delivery ابزارها و استراتژی‌های پشت APIOps رو معرفی میکنه. ابزارها و بهبودهای فرآیندی رو کشف میکنی که بردهای سریع و مهمی (Quick wins) بهت میدن، مثل حاکمیت API (Governance) با استفاده از لینتر Spectral و راه انداختن یه پایپ‌لاین CI/CD کارآمد با GitHub Actions. حتی یاد میگیری چطور از OpenAPI Generator قدرتمند استفاده کنی تا کدهای کلاینت و سرور رو به صورت خودکار از روی تعاریف API بسازی.

📦 محتوای کتاب

• بررسی تغییرات مخرب با oasdiff

• ساخت SDK با استفاده از OpenAPI Generator

• نگهداری داکیومنتیشن دقیق با تست‌های انطباق API

• دیپلوی تنظیمات API Gateway با GitOps

👥 مخاطب کتاب تجربه ساخت APIهای RESTful لازمه.

📑 فهرست مطالب

1. APIOps چیست؟
2. ورود به APIOps: حل مسئله و رهبری بهبودها
3. لینتینگ API: اتوماتیک‌سازی یکپارچگی API
4. بررسی تغییرات مخرب: مدیریت تکامل API
5. بازبینی طراحی API: بررسی چیزهایی که نمی‌توان اتوماتیک کرد
6. انطباق API: تولید کد و تعاریف API
7. انطباق API: تست اسکیما (Schema)
8. CI/CD برای آرتیفکت‌های API ۱: کنترل‌های حاکمیتی مرحله سورس
9. CI/CD برای آرتیفکت‌های API ۲: مرحله بیلد و دیپلوی تنظیمات API
10. بیشتر درباره یکپارچگی API: لینتینگ سفارشی و بررسی‌های امنیتی
11. مانیتورینگ و آنالیتیکس: اندازه‌گیری متریک‌های محصول API

پیوست‌ها

الف. آیکون‌های نقشه‌برداری جریان ارزش

ب. نصب ابزارهای لینتینگ API و OpenAPI diff

ج. مقدمه‌ای بر JSON Pointer

د. ابزارهای انطباق API و آنالیتیکس

ه. داکر و کوبرنتیز

📖 از پشت جلد

کتاب Automating API Delivery ابزارها و استراتژی‌های پشت APIOps رو معرفی میکنه. ابزارها و بهبودهای فرآیندی رو یاد میگیری که بردهای سریع و مهمی بهت میدن، شامل حاکمیت API با استفاده از لینتر Spectral و ایجاد یه پایپ‌لاین CI/CD کارآمد با GitHub Actions. حتی یاد میگیری چطور از OpenAPI Generator قدرتمند استفاده کنی تا کدهای کلاینت و سرور رو به صورت خودکار از روی تعاریف API بسازی.

👨‍💻 درباره نویسنده

ایکنا نوایوو (Ikenna Nwaiwu) رهبر تیم APIOps در شرکت 10x Banking هست. اون کارش رو به عنوان مهندس نرم‌افزار در ThoughtWorks شروع کرد و در شرکت‌های متعددی از جمله UBS و Bank of America کار کرده. اون مدرک لیسانس مهندسی از دانشگاه صنعتی فدرال اووری، فوق لیسانس تکنولوژی سیستم‌های نرم‌افزاری از دانشگاه شفیلد و MBA از مدرسه کسب‌وکاز وارویک داره.

Improve speed, quality, AND cost by automating your API delivery process!

Automating API Delivery shows you how to strike the perfect balance between speed and usability by applying DevOps automation principles to your API design and delivery process. It lays out a clear path to making both the organizational and technical changes you need to deliver high-quality APIs both rapidly and reliably.

In Automating API Delivery you’ll learn how to:

• Enforce API design standards with linting
• Automate breaking-change checks to control design creep
• Ensure accuracy of API reference documents
• Centralize API definition consistency checks
• Automate API configuration deployment
• Conduct effective API design reviews

Author Ikenna Nwaiwu provides comprehensive guidance on implementing APIOps in your organization. He carefully walks through the technical steps and introduces the essential open-source tools, with practical advice and insights from his years of experience. You’ll benefit from his personal tips for avoiding common pitfalls and challenges of moving to automated API delivery.

Foreword by Melissa van der Hecht.

About the technology

Create high quality, consistent, and fast-to-market APIs by automating the development process! This innovative book shows you how to apply established Continuous Delivery and DevOps principles along the whole API lifecycle, transforming a collection of individual tasks into a smooth, manageable pipeline that supports automated testing, iterative improvement, and reliable documentation.

About the book

Automating API Delivery introduces the tools and strategies behind APIOps. You’ll discover tools and process improvements that give you important quick wins, including API governance using the Spectral API linter and establishing an efficient CI/CD pipeline with GitHub Actions. You’ll even discover how to use the powerful OpenAPI Generator to automatically create client and server code from your API definitions.

What’s inside

• Check for breaking changes with oasdiff
• Create SDKs using OpenAPI Generator
• Maintain accurate documentation with API conformance tests
• Deploy API gateway configuration with GitOps

About the reader

Experience building RESTful APIs required.

Table of Contents

1. What is APIOps?

2. Leaning into APIOps: Problem-solving and leading improvements

3. API linting: Automating API consistency

4. Breaking change checks: Managing API evolution

5. API design review: Checking for what you cannot automate

6. API conformance: Generating code and API definitions

7. API conformance: Schema testing

8. CI/CD for API artifacts 1: Source-stage governance controls

9. CI/CD for API artifacts 2: Build-stage and API configuration deployment

10. More on API consistency: Custom linting and security checks

11. Monitoring and analytics: Measuring API product metrics

Appendixes

A. Value stream mapping icons

B. Installing API linting and OpenAPI diff tools

C. Introduction to JSON Pointer

D. Tools for API conformance and analytics

E. Docker and Kubernetes

From the back cover

Automating API Delivery introduces the tools and strategies behind APIOps. You’ll discover tools and process improvements that give you important quick wins, including API governance using the Spectral API linter and establishing an efficient CI/CD pipeline with GitHub Actions. You’ll even discover how to use the powerful OpenAPI Generator to automatically create client and server code from your API definitions.

About the Author

Ikenna Nwaiwu is the APIOps lead at 10x Banking. He started his career as a software engineer at ThoughtWorks and has worked at several companies, including UBS and Bank of America. He holds a BEng from the Federal University of Technology Owerri, an MSc in Software Systems Technology from the University of Sheffield, and an MBA from the Warwick Business School.