آموزش طراحی API های RESTful: طراحی API را از ابتدا یاد بگیرید

سرفصل ها و درس ها

معرفی دوره Course Introduction

• خوش آمدید و درباره این دوره Welcome & About This Course

• خوش آمدید و درباره این دوره Welcome & About This Course

• دانلود: طراحی راهنمای سریع API RESTful DOWNLOAD: Designing RESTful API Quick Guide

• دانلود کنید: الگوی سند طراحی API RESTful DOWNLOAD: RESTful API Design Document Template

• دانلود کنید: الگوی سند طراحی API RESTful DOWNLOAD: RESTful API Design Document Template

• دانلود: فایل مجموعه پستچی DOWNLOAD: Postman Collection File

• به گروه رسمی کدنویسی Masters بپیوندید Join the Official Coding Masters Group

• به گروه رسمی کدنویسی Masters بپیوندید Join the Official Coding Masters Group

معرفی دوره Course Introduction

• دانلود: طراحی راهنمای سریع API RESTful DOWNLOAD: Designing RESTful API Quick Guide

• دانلود: فایل مجموعه پستچی DOWNLOAD: Postman Collection File

شروع با طراحی API ها Getting Started with Designing APIs

• معرفی Introduction

• API چیست؟ What is API?

• چرا باید API طراحی کنید؟ Why Should You Design API?

• چرا باید API طراحی کنید؟ Why Should You Design API?

• مرحله 1: یک API جدید ایجاد کنید STEP 1: Create a New API

• مرحله 1: یک API جدید ایجاد کنید STEP 1: Create a New API

• انواع API Types of API

• مرحله 2: نوع API را شناسایی کنید STEP 2: Identify the Type of API

• مرحله 2: نوع API را شناسایی کنید STEP 2: Identify the Type of API

• آیا باید طراحی API موجود را تغییر دهید؟ Should You Change the Existing API Design?

• فعالیت: شروع با طراحی API ها ACTIVITY: Getting Started with Designing APIs

• خلاصه Summary

شروع با طراحی API ها Getting Started with Designing APIs

• معرفی Introduction

• API چیست؟ What is API?

• انواع API Types of API

• آیا باید طراحی API موجود را تغییر دهید؟ Should You Change the Existing API Design?

• فعالیت: شروع با طراحی API ها ACTIVITY: Getting Started with Designing APIs

• خلاصه Summary

مروری بر API های RESTful Overview of RESTful APIs

• معرفی Introduction

• HTTP چگونه کار می کند؟ How HTTP Works?

• HTTP چگونه کار می کند؟ How HTTP Works?

• بخش هایی از یک درخواست HTTP Parts of a HTTP Request

• بخش هایی از یک درخواست HTTP Parts of a HTTP Request

• DEMO: بخش هایی از یک درخواست HTTP DEMO: Parts of a HTTP Request

• REST چیست؟ What is REST?

• DEMO: API در Postman DEMO: API in Postman

• DEMO: API در Postman DEMO: API in Postman

• URL در مقابل URI URL vs URI

• مرحله 3: URL پایگاه سرور را شناسایی کنید STEP 3: Identify the Server Base URL

• فعالیت: مروری بر API های RESTful ACTIVITY: Overview of RESTful APIs

• خلاصه Summary

مروری بر API های RESTful Overview of RESTful APIs

• معرفی Introduction

• DEMO: بخش هایی از یک درخواست HTTP DEMO: Parts of a HTTP Request

• REST چیست؟ What is REST?

• URL در مقابل URI URL vs URI

• مرحله 3: URL پایگاه سرور را شناسایی کنید STEP 3: Identify the Server Base URL

• خلاصه Summary

طراحی منابع API Designing API Resources

• معرفی Introduction

• منابع باید اسم باشند Resources should be Nouns

• مرحله 4: منابع را شناسایی کنید STEP 4: Identify the Resources

• مرحله 4: منابع را شناسایی کنید STEP 4: Identify the Resources

• منابع باید مجموعه باشند Resources should be Collections

• منابع باید مجموعه باشند Resources should be Collections

• مرحله 5: منابع را جمع کنید STEP 5: Have the Resources as Plural

• مرحله 5: منابع را جمع کنید STEP 5: Have the Resources as Plural

• مرحله 6: مدل های منابع را تعریف کنید STEP 6: Define the Resource Models

• مرحله 6: مدل های منابع را تعریف کنید STEP 6: Define the Resource Models

• از شناسه های منحصر به فرد استفاده کنید Use Unique Identifiers

• مرحله 7: شناسه هر منبع را انتخاب کنید STEP 7: Select the Identifier for Each Resource

• داده های غیر منبع باید پارامترهای Query باشند Non-resource Data should be Query Parameters

• فعالیت: طراحی منابع API ACTIVITY: Designing API Resources

• خلاصه Summary

طراحی منابع API Designing API Resources

• معرفی Introduction

• منابع باید اسم باشند Resources should be Nouns

• از شناسه های منحصر به فرد استفاده کنید Use Unique Identifiers

• مرحله 7: شناسه هر منبع را انتخاب کنید STEP 7: Select the Identifier for Each Resource

• داده های غیر منبع باید پارامترهای Query باشند Non-resource Data should be Query Parameters

• فعالیت: طراحی منابع API ACTIVITY: Designing API Resources

• خلاصه Summary

طراحی ارتباط بین منابع Designing Associations between Resources

• معرفی Introduction

• تعریف روابط بین منابع Defining Relationships between Resources

• مرحله 8: انجمن را برای هر منبع شناسایی کنید STEP 8: Identify the Association for Each Resource

• مرحله 8: انجمن را برای هر منبع شناسایی کنید STEP 8: Identify the Association for Each Resource

• URL نباید پیچیده باشد URL Shouldn’t be Complex

• URL نباید پیچیده باشد URL Shouldn’t be Complex

• مرحله 9: پیچیدگی URL را بررسی کنید STEP 9: Check for the URL Complexity

• مرحله 9: پیچیدگی URL را بررسی کنید STEP 9: Check for the URL Complexity

• ترکیب منابع مرتبط Combine Related Resources

• ترکیب منابع مرتبط Combine Related Resources

• فعالیت: طراحی ارتباط بین منابع ACTIVITY: Designing Associations between Resources

• خلاصه Summary

طراحی ارتباط بین منابع Designing Associations between Resources

• تعریف روابط بین منابع Defining Relationships between Resources

• فعالیت: طراحی ارتباط بین منابع ACTIVITY: Designing Associations between Resources

• خلاصه Summary

طراحی عملیات API Designing API Operations

• معرفی Introduction

• مروری بر عملیات HTTP Overview of HTTP Operations

• مروری بر عملیات HTTP Overview of HTTP Operations

• عملیات رایج HTTP Common HTTP Operations

• انتخاب عملیات بر اساس آیتم یا مجموعه فردی Selecting Operations based on Individual Item or Collection

• روش های بی توان Idempotent Methods

• تفاوت بین POST، PUT و PATCH Differences between POST, PUT, and PATCH

• تفاوت بین POST، PUT و PATCH Differences between POST, PUT, and PATCH

• مرحله 10: عملیات هر منبع را شناسایی کنید STEP 10: Identify the Operations for Each Resource

• مرحله 10: عملیات هر منبع را شناسایی کنید STEP 10: Identify the Operations for Each Resource

• فعالیت: طراحی عملیات API ACTIVITY: Designing API Operations

• خلاصه Summary

طراحی عملیات API Designing API Operations

• معرفی Introduction

• عملیات رایج HTTP Common HTTP Operations

• انتخاب عملیات بر اساس آیتم یا مجموعه فردی Selecting Operations based on Individual Item or Collection

• روش های بی توان Idempotent Methods

• فعالیت: طراحی عملیات API ACTIVITY: Designing API Operations

• خلاصه Summary

طراحی درخواست های API Designing API Requests

• معرفی Introduction

• طراحی پارامترهای درخواست Designing Request Parameters

• مرحله 11: پارامترهای مورد نیاز برای عملیات را شناسایی کنید STEP 11: Identify the Parameters Required for the Operation

• طراحی محتوای درخواستی Designing Request Content

• طراحی محتوای درخواستی Designing Request Content

• مرحله 12: نوع محتوای درخواست عملیات را مشخص کنید STEP 12: Identify the Content Type of Request for the Operation

• مرحله 13: سازمان درخواست کننده عملیات را شناسایی کنید STEP 13: Identify the Request Body for the Operation

• فعالیت: طراحی درخواست های API ACTIVITY: Designing API Requests

• خلاصه Summary

طراحی درخواست های API Designing API Requests

• معرفی Introduction

• طراحی پارامترهای درخواست Designing Request Parameters

• مرحله 11: پارامترهای مورد نیاز برای عملیات را شناسایی کنید STEP 11: Identify the Parameters Required for the Operation

• مرحله 12: نوع محتوای درخواست عملیات را مشخص کنید STEP 12: Identify the Content Type of Request for the Operation

• مرحله 13: سازمان درخواست کننده عملیات را شناسایی کنید STEP 13: Identify the Request Body for the Operation

• فعالیت: طراحی درخواست های API ACTIVITY: Designing API Requests

طراحی پاسخ های API Designing API Responses

• معرفی Introduction

• کدهای وضعیت HTTP HTTP Status Codes

• طراحی کدهای وضعیت در پاسخ Designing Status Codes in Responses

• مرحله 14: کدهای وضعیت HTTP را برای عملیات شناسایی کنید STEP 14: Identify the HTTP Status Codes for the Operation

• انتخاب فرمت پاسخ ها Choosing the Format of Responses

• انتخاب فرمت پاسخ ها Choosing the Format of Responses

• مرحله 15: نوع محتوای پاسخ را برای عملیات شناسایی کنید STEP 15: Identify the Content Type of Response for the Operation

• مرحله 15: نوع محتوای پاسخ را برای عملیات شناسایی کنید STEP 15: Identify the Content Type of Response for the Operation

• طراحی بدنه پاسخ Designing Response Body

• طراحی بدنه پاسخ Designing Response Body

• مرحله 16: سازمان پاسخگوی عملیات را شناسایی کنید STEP 16: Identify the Response Body for the Operation

• طراحی مدیریت خطا Designing Error Handling

• طراحی مدیریت خطا Designing Error Handling

• مرحله 17: خطاها را برای عملیات مدیریت کنید STEP 17: Handle Errors for the Operation

• مرحله 17: خطاها را برای عملیات مدیریت کنید STEP 17: Handle Errors for the Operation

• فعالیت: طراحی پاسخ های API ACTIVITY: Designing API Responses

• فعالیت: طراحی پاسخ های API ACTIVITY: Designing API Responses

• خلاصه Summary

طراحی پاسخ های API Designing API Responses

• معرفی Introduction

• کدهای وضعیت HTTP HTTP Status Codes

• طراحی کدهای وضعیت در پاسخ Designing Status Codes in Responses

• مرحله 14: کدهای وضعیت HTTP را برای عملیات شناسایی کنید STEP 14: Identify the HTTP Status Codes for the Operation

• مرحله 16: سازمان پاسخگوی عملیات را شناسایی کنید STEP 16: Identify the Response Body for the Operation

• خلاصه Summary

طراحی برای فیلتر کردن، صفحه بندی و مرتب سازی Design for Filtering, Pagination, and Sorting

• معرفی Introduction

• پشتیبانی از فیلتر کردن داده ها Support for Filtering Data

• مرحله 18: نیاز به فیلتر را شناسایی کنید و در صورت نیاز اضافه کنید STEP 18: Identify the Need for Filtering and Add If Needed

• پشتیبانی از صفحه بندی داده ها Support for Pagination of Data

• مرحله 19: نیاز به صفحه بندی را شناسایی کنید و در صورت نیاز اضافه کنید STEP 19: Identify the Need for Pagination and Add If Needed

• مرحله 19: نیاز به صفحه بندی را شناسایی کنید و در صورت نیاز اضافه کنید STEP 19: Identify the Need for Pagination and Add If Needed

• پشتیبانی از مرتب سازی داده ها Support for Sorting Data

• پشتیبانی از مرتب سازی داده ها Support for Sorting Data

• مرحله 20: نیاز به مرتب سازی را شناسایی کنید و در صورت نیاز اضافه کنید STEP 20: Identify the Need for Sorting and Add If Needed

• مرحله 20: نیاز به مرتب سازی را شناسایی کنید و در صورت نیاز اضافه کنید STEP 20: Identify the Need for Sorting and Add If Needed

• خلاصه Summary

طراحی برای فیلتر کردن، صفحه بندی و مرتب سازی Design for Filtering, Pagination, and Sorting

• معرفی Introduction

• پشتیبانی از فیلتر کردن داده ها Support for Filtering Data

• مرحله 18: نیاز به فیلتر را شناسایی کنید و در صورت نیاز اضافه کنید STEP 18: Identify the Need for Filtering and Add If Needed

• پشتیبانی از صفحه بندی داده ها Support for Pagination of Data

• خلاصه Summary

طراحی نسخه های API Designing API Versions

• معرفی Introduction

• معرفی Introduction

• چرا باید API ها را نسخه کنید؟ Why you Should Version APIs?

• چرا باید API ها را نسخه کنید؟ Why you Should Version APIs?

• راه هایی برای API های نسخه Ways to Version APIs

• رویکرد 1: بدون نسخه Approach 1: No versioning

• رویکرد 2: نسخه URL Approach 2: URL Versioning

• رویکرد 2: نسخه URL Approach 2: URL Versioning

• رویکرد 3: نسخه بندی رشته پرس و جو Approach 3: Query String Versioning

• رویکرد 4: نسخه هدر Approach 4: Header Versioning

• رویکرد 5: نسخه سازی نوع رسانه Approach 5: Media Type Versioning

• رویکرد 5: نسخه سازی نوع رسانه Approach 5: Media Type Versioning

• از کدام رویکرد نسخه سازی استفاده کنیم؟ Which Versioning Approach to Use?

• از کدام رویکرد نسخه سازی استفاده کنیم؟ Which Versioning Approach to Use?

• مرحله ۲۱: طرح نسخه‌سازی API را شناسایی کرده و نسخه API را تنظیم کنید STEP 21: Identify the API Versioning Scheme and Set the API Version

• خلاصه Summary

• خلاصه Summary

طراحی نسخه های API Designing API Versions

• معرفی Introduction

• راه هایی برای API های نسخه Ways to Version APIs

• رویکرد 1: بدون نسخه Approach 1: No versioning

• رویکرد 3: نسخه بندی رشته پرس و جو Approach 3: Query String Versioning

• رویکرد 4: نسخه هدر Approach 4: Header Versioning

• مرحله ۲۱: طرح نسخه‌سازی API را شناسایی کرده و نسخه API را تنظیم کنید STEP 21: Identify the API Versioning Scheme and Set the API Version

• خلاصه Summary

تکلیف: کار با دانش آموزان ASSIGNMENT: Working with Students

• فعالیت: شروع با طراحی API ها ACTIVITY: Getting Started with Designing APIs

• فعالیت: مروری بر API های RESTful ACTIVITY: Overview of RESTful APIs

• فعالیت: مروری بر API های RESTful ACTIVITY: Overview of RESTful APIs

• فعالیت: طراحی منابع API ACTIVITY: Designing API Resources

• فعالیت: طراحی منابع API ACTIVITY: Designing API Resources

• فعالیت: طراحی ارتباط بین منابع ACTIVITY: Designing Associations between Resources

• فعالیت: طراحی ارتباط بین منابع ACTIVITY: Designing Associations between Resources

تکلیف: کار با دانش آموزان ASSIGNMENT: Working with Students

• فعالیت: شروع با طراحی API ها ACTIVITY: Getting Started with Designing APIs

• فعالیت: مروری بر API های RESTful ACTIVITY: Overview of RESTful APIs

نتیجه گیری دوره Course Conclusion

• تبریک می گویم! Congratulations!

• تبریک می گویم! Congratulations!

• سخنرانی پاداش Bonus Lecture

• سخنرانی پاداش Bonus Lecture

نتیجه گیری دوره Course Conclusion