آموزش دوره جامع ابزارهای Swagger: طراحی OpenAPI به ساده‌ترین شکل - آخرین آپدیت

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

مقدمه‌ای بر دوره Introduction to the Course

• درباره دوره About the Course

شروع کار با ابزارهای Swagger Getting Started with Swagger Tools

• مقدمه Introduction

• تفاوت Swagger و OpenAPI Swagger Versus OpenAPI

• مروری بر Swagger Overview of Swagger

• رویکرد ابتدا طراحی در مقابل ابتدا کدنویسی Design-First Versus Code-First

• مروری بر پروژه نمونه Overview of the Demo Project

• جمع‌بندی Conclusion

مروری کلی بر SwaggerHub SwaggerHub - An Overview

• مقدمه Introduction

• گام اول: ایجاد حساب کاربری SwaggerHub Step 1: Creating SwaggerHub Account

• گام دوم: درک ساختار سلسله‌مراتبی Step 2: Understanding Hierarchy Structure

• گام سوم: وارد کردن یک API موجود Step 3: Importing an Existing API

• گام چهارم: پیمایش در SwaggerHub Step 4: Navigating SwaggerHub

• گام پنجم: ایجاد یک API جدید Step 5: Creating a New API

• جمع‌بندی Conclusion

Swagger Editor و Swagger UI ایجاد یک API جدید Swagger Editor and Swagger UI - Creating a New API

• مقدمه Introduction

• گام اول: افزودن نسخه OpenAPI Step 1: Add the OpenAPI Version

• گام دوم: افزودن متادیتا Step 2: Add Metadata

• گام سوم: افزودن مراجع اضافی Step 3: Add Additional References

• گام چهارم: افزودن جزئیات سرور Step 4: Add Server Details

• گام پنجم: افزودن تگ‌ها برای گروه‌بندی عملیات API Step 5: Add Tags to Group API Operations

• گام ششم: افزودن مسیرها (بخش اول: جزئیات مسیر) Step 6: Add Paths (Part 1: Path Details)

• گام ششم: افزودن مسیرها (بخش دوم: عملیات‌ها) Step 6: Add Paths (Part 2: Operations)

• گام ششم: افزودن مسیرها (بخش سوم: پارامترها) Step 6: Add Paths (Part 3: Parameters)

• گام ششم: افزودن مسیرها (بخش چهارم: پاسخ‌ها) Step 6: Add Paths (Part 4: Responses)

• گام ششم: افزودن مسیرها (بخش پنجم: بدنه درخواست) Step 6: Add Paths (Part 5: Request Body)

• گام هفتم: افزودن کامپوننت‌ها Step 7: Add Components

• گام هشتم: افزودن امنیت Step 8: Add Security

• حل تمرین اول: افزودن عملیات برای آیتم‌های دوره Assignment 1 Solution: Adding Operations for Individual Course Item

• جمع‌بندی Conclusion

مدیریت APIها Managing the APIs

• مقدمه Introduction

• فورک کردن (Forking) یک API Forking an API

• منتشر کردن یک API Publishing an API

• نسخه‌بندی یک API Versioning an API

• حذف یک API Deleting an API

• شبیه‌سازی (Mocking) API Mocking API

• جمع‌بندی Conclusion

Swagger Codegen تولید Server Stub Swagger Codegen - Generating Server Stub

• مقدمه Introduction

• مروری بر Swagger Codegen Overview of Swagger Codegen

• گام اول: تنظیم گزینه‌های Server Codegen Step 1: Setting the Server Codegen Options

• گام دوم: تولید کد Server Stub Step 2: Generating the Server Stub Code

• گام سوم: بیلد کردن کدهای تولید شده Step 3: Building the Generated Codes

• گام چهارم: تست Server Stub Step 4: Testing the Server Stub

• جمع‌بندی Conclusion

Swagger Inspector تست سرور API Swagger Inspector - Testing API Server

• مقدمه Introduction

• گام اول: وارد کردن مشخصات OpenAPI Step 1: Import the OpenAPI Specification

• گام دوم: آماده‌سازی یک عملیات برای اجرا Step 2: Preparing an Operation for Execution

• گام سوم: اجرای عملیات Step 3: Executing the Operation

• گام چهارم: ایجاد تعریف API Step 4: Creating API Definition

• جمع‌بندی Conclusion

Swagger Codegen تولید Client SDK Swagger Codegen - Generating Client SDK

• مقدمه Introduction

• گام اول: تنظیم گزینه‌های Client Codegen Step 1: Setting the Client Codegen Options

• گام دوم: تولید کد Client SDK Step 2: Generating the Client SDK Code

• گام سوم: بیلد کردن کدهای تولید شده Step 3: Building the Generated Codes

• جمع‌بندی Conclusion

SwaggerHub همکاری با دیگران SwaggerHub - Collaborating with Others

• مقدمه Introduction

• مروری بر سلسله‌مراتب SwaggerHub Overview of SwaggerHub Hierarchy

• گام اول: ایجاد یک سازمان جدید Step 1: Creating a New Organization

• گام دوم: ایجاد یک پروژه جدید Step 2: Creating a New Project

• گام سوم: ایجاد یک تیم جدید Step 3: Creating a New Team

• گام چهارم: ایجاد APIها و دامنه‌ها Step 4: Creating APIs and Domains

• گام پنجم: همکاری با اعضای تیم Step 5: Collaborating with Team Members

• جمع‌بندی Conclusion