توضیحات

آموزش مستند سازی API با Swagger

نام دوره: Learn Swagger and the OpenAPI Specification

پیش نیاز:

باید بدانید که REST APIها چگونه کار می کنند
شما باید بتوانید JSON را بخوانید و درک کنید

توضیحات:

مشخصات OpenAPI (اغلب “Swagger” نامیده می شود) در حال حاضر محبوب ترین راه برای ایجاد تعاریف از API های RESTful است.

با این تعاریف، می‌توانید اسناد پیچیده و خودکار ایجاد کنید، SDK‌ها را به چندین زبان تولید کنید و آزمایش‌های خودکار انجام دهید.

Swagger مجموعه ای از ابزارهای منبع باز است که از این فایل های تعریف Open API Specification استفاده می کند.

این کلاس برای افرادی در صنعت نرم افزار است که نسبتاً فنی هستند، اما توسعه دهندگان نرم افزار نیستند:

به عنوان مثال، مدیران پروژه، مدیران محصول API و نویسندگان فنی. فرض بر این است که شما REST و JSON را می‌دانید، اما این همه چیز است.

این دوره برای افرادی است که به تازگی با مشخصات Open API و Swagger آشنا هستند، نه برای متخصصان.

در دوره آموزش مستند سازی API با Swagger پوشش می دهیم:

• کارهایی که می توانید با فایل های OpenAPI Specification (OAS) انجام دهید
• فرمت فایل YAML
• نحوه ایجاد یک فایل OAS
• نحوه تعیین امنیت
• نحوه اضافه کردن اسناد
• نحوه نوشتن یک فایل OAS در JSON
• جایگزین های Swagger و OAS
• این کلاس شامل موارد زیر نمی شود:
• چگونه Swagger را روی سرور خود راه اندازی کنید
• نحوه تغییر کد منبع باز Swagger

علاوه بر ویدیوها، این دوره شامل 8 تمرین عملی است که شما را به صورت گام به گام در ایجاد یک فایل تعریف API راهنمایی می کند، از جمله پروژه نهایی که در آن یک فایل از ابتدا با استفاده از مستندات یک API تجاری واقعی ایجاد می کنید.

همچنین حاوی یک سند با منابع در مورد یادگیری بیشتر در مورد OAS، Swagger، و جایگزین است.

علاوه بر سخنرانی های ویدئویی، انتظار داشته باشید که حداقل 4 ساعت را برای انجام تمرینات اختصاص دهید. این تمرین‌ها کلید درک Swagger و OAS هستند.

مهم: این دوره از OAS 2 استفاده می کند. نسخه جدیدتر، OAS 3، شروع به استفاده بیشتر کرده است، اما بسیاری از شرکت ها هنوز از OAS 2 استفاده می کنند.

یک سخنرانی وجود دارد که شما را به تفاوت های بین OAS 2 و OAS 3 راهنمایی می کند.

دوره  آموزش مستند سازی API با Swagger برای چه کسانی است:

• هر کسی که می خواهد بتواند فایل های Open API Specification (Swagger) را بخواند یا بنویسد
• مدیران پروژه
• نویسندگان فنی
• کادر فنی فروش
• مدیران دارای مهارت فنی

بخشی از دوره :