دوره آموزشی ایجاد مستندات API
30 دقیقهمبتدی2022-07-21
مدرسین

Deepa Maddala
Experienced Consultant and PL/SQL Developer in Information Technology
جزئیات دوره
با API های زیادی در بازار، پیگیری اینکه چه چیزی چیست دشوار است. برای برنامه نویسان، تحلیلگران، معماران و نویسندگان فنی که هر روز با API ها کار می کنند، نمی توانید اهمیت اسناد واضح، مختصر و آسان برای استفاده را اغراق کنید. در این دوره آموزشی، مدرس و توسعهدهنده Deepa Maddala به شما نشان میدهد که چگونه مستندات API موثر و قابل دسترسی را بر اساس بهترین شیوههای فعلی و ابزارهای یکپارچه ایجاد کنید.
اصول APIها و اهمیت نوشتن اسناد استاندارد API را بیاموزید. اجزای مستندات مؤثر از جمله نام، توضیحات، نقاط پایانی، مجوز، پارامترها، سرصفحهها و بارهای درخواست و پاسخ را بررسی کنید. در طول مسیر، دیپا به شما نکاتی را در مورد نحوه ادغام اسناد خود با ابزارهایی مانند Swagger، Postman و Confluence ارائه می دهد.
اصول APIها و اهمیت نوشتن اسناد استاندارد API را بیاموزید. اجزای مستندات مؤثر از جمله نام، توضیحات، نقاط پایانی، مجوز، پارامترها، سرصفحهها و بارهای درخواست و پاسخ را بررسی کنید. در طول مسیر، دیپا به شما نکاتی را در مورد نحوه ادغام اسناد خود با ابزارهایی مانند Swagger، Postman و Confluence ارائه می دهد.
مهارت ها
APIRESTAPIsOpen SourceSoftware DevelopmentOne-Off
سرفصل ها
0. مقدمه
- 01 - مقدمه ای بر API ها
1. پایههای API
- 02 - API چیست
- 03 - انواع API
2. اسناد API
- 04 - مستندات API چیست
- 05 - اهمیت اسناد API
3. اجزای اسناد API
- 06 - نام، توضیحات و نقاط پایانی
- 07 - مجوز، پارامترها و هدرها
- 08 - درخواست و پاسخ
4. یکپارچه سازی اسناد با ابزارهای API
- 09 - فحش دادن
- 10 - پستچی
- 11 - تلاقی
نتیجه
- 12 - مراحل بعدی