لطفا جهت اطلاع از آخرین دوره ها و اخبار سایت در
کانال تلگرام
عضو شوید.
آموزش مستندسازی موثر APIها
Documenting APIs Effectively
نکته:
آخرین آپدیت رو دریافت میکنید حتی اگر این محتوا بروز نباشد.
نمونه ویدیوها:
توضیحات دوره:
هنگام ایجاد API، طبیعی است که روی جنبه های فنی مانند ساخت کد، آزمایش، ساخت و استقرار تمرکز کنید. اغلب اوقات، این منجر به اسناد محدود یا بدون اسناد برای راهنمایی مصرف کنندگان API می شود. با گذشت زمان، ابزارها و استانداردها برای پشتیبانی از مستندسازی API های شما در مراحل اولیه تکامل یافته اند، ابزارها حتی می توانند به طور خودکار اسناد و کد را برای شما تولید کنند. در این دوره، مستندسازی APIها به طور موثر، استراتژیهایی برای مستندسازی API، استفاده از بهترین شیوهها و نمونههای دنیای واقعی را یاد خواهید گرفت. ابتدا، خواهید فهمید که چرا اسناد API برای نتایج موفقیت آمیز مصرف کنندگان بسیار مهم است. در مرحله بعد، با ابزارها و مشخصاتی آشنا می شوید که می توانند به خودکارسازی و استانداردسازی ایجاد و تنظیم اسناد کمک کنند. در نهایت، نحوه مستندسازی جنبههای مختلف API خود، از جمله اسناد مرجع و راهنماهای توسعهدهنده را خواهید دید. پس از اتمام این دوره، مهارت ها و دانش لازم در مورد اسناد API را خواهید داشت تا اطمینان حاصل شود که مصرف کنندگان شما می توانند با موفقیت درک کنند و به نتایجی که در هنگام استفاده از API شما به عنوان بخشی از راه حل خود انتظار دارند دست یابند.
سرفصل ها و درس ها
بررسی اجمالی دوره
Course Overview
چرا مستندسازی APIها حیاتی است؟
Why Is It Critical to Document APIs?
مستندسازی API های خود با مشخصات OpenAPI
Documenting Your APIs with the OpenAPI Specification
استفاده از ابزار با مشخصات OpenAPI
Using Tooling with the OpenAPI Specification
ایجاد پورتال توسعه دهنده
Creating a Developer Portal
مایکل یک معمار ارشد فنی در NVISIA است. او تقریباً بیست سال در زمینه فناوری برای انواع مشتریان در چندین صنعت مختلف کار کرده است. او علاقه زیادی به تدریس و راهنمایی دارد. پانزده دقیقه از شهرت او رسیدن به سطل شماره 3 در نمایشگاه بوزو بود. وی دارای مدرک لیسانس علوم کامپیوتر و سیستم های اطلاعاتی از دانشگاه DePaul است و در حال حاضر در منطقه شهری شیکاگو اقامت دارد.
نمایش نظرات