ایجاد مستندات API

با وجود بسیاری از API های موجود در بازار ، پیگیری آنچه چیست ، دشوار است. برای برنامه نویسان ، تحلیلگران ، معماران و نویسندگان فنی که هر روز با API کار می کنند ، نمی توانید اهمیت مستندات واضح ، مختصر و آسان استفاده کنید. در این دوره ، مربی و توسعه دهنده Deepa Maddala به شما نشان می دهد که چگونه می توانید مستندات API مؤثر و قابل دسترسی را بر اساس بهترین شیوه های فعلی و ابزارهای یکپارچه ایجاد کنید. اصول اولیه API ها و اهمیت نوشتن مستندات API استاندارد را نشان دهید. اجزای مستندات مؤثر از جمله نام ، توضیحات ، نقاط پایانی ، مجوز ، پارامترها ، هدرها و بارهای درخواست و پاسخ را کاوش کنید. در طول راه ، Deepa نکاتی را در مورد چگونگی ادغام مستندات خود با ابزارهایی مانند Swagger ، Postman و Confluence به شما ارائه می دهد.

عنوان اصلی : Creating API Documentation

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

مقدمه:
مقدمه API
1. بنیادهای API:
API چیست؟
انواع API
2. مستندات API:
مستندات API چیست؟
اهمیت مستندات API
3. مؤلفه های مستندات API:
نام ، توضیحات و نقاط پایانی
مجوز ، پارامترها و هدرها
درخواست و پاسخ
4. ادغام اسناد با ابزارهای API:
swagger
پستچی
تلاقی
نتیجه گیری:
مراحل بعدی