آموزش ایجاد اسناد API
Creating API Documentation
نکته:
آخرین آپدیت رو دریافت میکنید حتی اگر این محتوا بروز نباشد.
نمونه ویدیوها:
با وجود APIهای زیادی در بازار، پیگیری اینکه چه چیزی چیست دشوار است. برای برنامه نویسان، تحلیلگران، معماران و نویسندگان فنی که هر روز با API ها کار می کنند، نمی توانید اهمیت اسناد واضح، مختصر و آسان برای استفاده را اغراق کنید. در این دوره آموزشی، مدرس و توسعه‌دهنده دیپا مدالا به شما نشان می‌دهد که چگونه می‌توانید مستندات API مؤثر و قابل دسترسی را بر اساس بهترین شیوه‌های فعلی و ابزارهای یکپارچه ایجاد کنید.
اصول APIها و اهمیت نوشتن اسناد استاندارد API را بیاموزید. اجزای مستندات مؤثر از جمله نام، توضیحات، نقاط پایانی، مجوز، پارامترها، سرصفحه‌ها و بارهای درخواست و پاسخ را بررسی کنید. در طول مسیر، دیپا نکاتی را در مورد نحوه ادغام اسناد خود با ابزارهایی مانند Swagger، Postman و Confluence به شما ارائه می دهد.
اصول APIها و اهمیت نوشتن اسناد استاندارد API را بیاموزید. اجزای مستندات مؤثر از جمله نام، توضیحات، نقاط پایانی، مجوز، پارامترها، سرصفحه‌ها و بارهای درخواست و پاسخ را بررسی کنید. در طول مسیر، دیپا نکاتی را در مورد نحوه ادغام اسناد خود با ابزارهایی مانند Swagger، Postman و Confluence به شما ارائه می دهد.
سرفصل ها و درس ها
مقدمه Introduction
-
مقدمه ای بر API ها Introduction to APIs
1. پایه های API 1. API Foundations
-
API چیست؟ What is an API?
-
انواع API ها Types of APIs
2. اسناد API 2. API Documentation
-
مستندات API چیست؟ What is API documentation?
-
اهمیت اسناد API The importance of API documentation
3. اجزای اسناد API 3. Components of API Documentation
-
نام، توضیحات و نقاط پایانی Name, description, and endpoints
-
مجوز، پارامترها و هدرها Authorization, parameters, and headers
-
درخواست و پاسخ Request and response
4. یکپارچه سازی اسناد با ابزارهای API 4. Integrating Documentation with API Tools
-
فحش دادن Swagger
-
پستچی Postman
-
تلاقی Confluence
نتیجه Conclusion
-
مراحل بعدی Next steps
https://donyad.com/d/b546
Deepa Maddala
مشاور با تجربه و توسعه دهنده PL/SQL در فناوری اطلاعات
deiva maddala یک مشاور با تجربه و توسعه دهنده PL/SQL با اشتیاق برای تکنولوژی است.
DeaPa به عنوان یک مشاور در شرکت Hewlett Packard و به عنوان توسعه دهنده PL/SQL برای BP کار کرده است. یک یادگیرنده مشتاق با استعداد برای تجزیه و تحلیل ریشه ریشه، او در SQL، PL/SQL، تجزیه و تحلیل مورد نیاز، پشتیبانی تولید و SDLC کار کرده است. او در طراحی و توسعه نرم افزار شرکت کرده است و همچنین در SAP Security، GRC و SAP ECC6.0 ماهر است.
DeaPa به عنوان یک مشاور در شرکت Hewlett Packard و به عنوان توسعه دهنده PL/SQL برای BP کار کرده است. یک یادگیرنده مشتاق با استعداد برای تجزیه و تحلیل ریشه ریشه، او در SQL، PL/SQL، تجزیه و تحلیل مورد نیاز، پشتیبانی تولید و SDLC کار کرده است. او در طراحی و توسعه نرم افزار شرکت کرده است و همچنین در SAP Security، GRC و SAP ECC6.0 ماهر است.
نمایش نظرات