آموزش مستندسازی موثر APIها

Documenting APIs Effectively

نکته: آخرین آپدیت رو دریافت میکنید حتی اگر این محتوا بروز نباشد.
نمونه ویدیوها:
توضیحات دوره: هنگام ایجاد API، طبیعی است که روی جنبه های فنی مانند ساخت کد، آزمایش، ساخت و استقرار تمرکز کنید. اغلب اوقات، این منجر به اسناد محدود یا بدون اسناد برای راهنمایی مصرف کنندگان API می شود. با گذشت زمان، ابزارها و استانداردها برای پشتیبانی از مستندسازی API های شما در مراحل اولیه تکامل یافته اند، ابزارها حتی می توانند به طور خودکار اسناد و کد را برای شما تولید کنند. در این دوره، مستندسازی APIها به طور موثر، استراتژی‌هایی برای مستندسازی API، استفاده از بهترین شیوه‌ها و نمونه‌های دنیای واقعی را یاد خواهید گرفت. ابتدا، خواهید فهمید که چرا اسناد API برای نتایج موفقیت آمیز مصرف کنندگان بسیار مهم است. در مرحله بعد، با ابزارها و مشخصاتی آشنا می شوید که می توانند به خودکارسازی و استانداردسازی ایجاد و تنظیم اسناد کمک کنند. در نهایت، نحوه مستندسازی جنبه‌های مختلف API خود، از جمله اسناد مرجع و راهنماهای توسعه‌دهنده را خواهید دید. پس از اتمام این دوره، مهارت ها و دانش لازم در مورد اسناد API را خواهید داشت تا اطمینان حاصل شود که مصرف کنندگان شما می توانند با موفقیت درک کنند و به نتایجی که در هنگام استفاده از API شما به عنوان بخشی از راه حل خود انتظار دارند دست یابند.

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

بررسی اجمالی دوره Course Overview

  • بررسی اجمالی دوره Course Overview

  • بررسی اجمالی دوره Course Overview

چرا مستندسازی APIها حیاتی است؟ Why Is It Critical to Document APIs?

  • معرفی Introduction

  • معرفی Introduction

  • بررسی نسخه Version Check

  • بررسی نسخه Version Check

  • آشنایی با اصول یک API Understanding the Fundamentals of an API

  • آشنایی با اصول یک API Understanding the Fundamentals of an API

  • مزایای وب API چیست؟ What Are the Benefits of Web APIs?

  • مزایای وب API چیست؟ What Are the Benefits of Web APIs?

  • چرا باید API های وب خود را مستند کنید؟ Why Must You Document Your Web APIs?

  • چرا باید API های وب خود را مستند کنید؟ Why Must You Document Your Web APIs?

مستندسازی API های خود با مشخصات OpenAPI Documenting Your APIs with the OpenAPI Specification

  • معرفی مشخصات OpenAPI Introducing the OpenAPI Specification

  • معرفی مشخصات OpenAPI Introducing the OpenAPI Specification

  • مستندسازی جزئیات API بنیادی Documenting Foundational API Details

  • مستندسازی جزئیات API بنیادی Documenting Foundational API Details

  • مستندسازی مسیرها و اجزای API Documenting API Paths and Components

  • مستندسازی مسیرها و اجزای API Documenting API Paths and Components

  • مستندسازی خطاهای API Documenting API Errors

  • مستندسازی خطاهای API Documenting API Errors

  • مستندسازی نسخه API Documenting API Versioning

  • مستندسازی نسخه API Documenting API Versioning

  • خلاصه ماژول Module Summary

  • خلاصه ماژول Module Summary

استفاده از ابزار با مشخصات OpenAPI Using Tooling with the OpenAPI Specification

  • درک چشم انداز ابزار OpenAPI Understanding the OpenAPI Tooling Landscape

  • درک چشم انداز ابزار OpenAPI Understanding the OpenAPI Tooling Landscape

  • بررسی اجمالی Swagger Swagger Overview

  • بررسی اجمالی Swagger Swagger Overview

  • بررسی اجمالی پستچی Postman Overview

  • بررسی اجمالی پستچی Postman Overview

  • بررسی اجمالی Reocly Redocly Overview

  • بررسی اجمالی Reocly Redocly Overview

  • نمای کلی پشت صحنه Backstage Overview

  • نمای کلی پشت صحنه Backstage Overview

ایجاد پورتال توسعه دهنده Creating a Developer Portal

  • شروع کار با پورتال توسعه دهنده API Getting Started with an API Developer Portal

  • شروع کار با پورتال توسعه دهنده API Getting Started with an API Developer Portal

  • ایجاد محتوا برای پورتال توسعه دهندگان Creating Content for a Developer Portal

  • ایجاد محتوا برای پورتال توسعه دهندگان Creating Content for a Developer Portal

  • نتیجه گیری دوره Course Conclusion

  • نتیجه گیری دوره Course Conclusion

نمایش نظرات

آموزش مستندسازی موثر APIها
جزییات دوره
1h 2m
40
Pluralsight (پلورال سایت) Pluralsight (پلورال سایت)
(آخرین آپدیت)
از 5
دارد
دارد
دارد
جهت دریافت آخرین اخبار و آپدیت ها در کانال تلگرام عضو شوید.

Google Chrome Browser

Internet Download Manager

Pot Player

Winrar

Michael Hoffman Michael Hoffman

مایکل یک معمار ارشد فنی در NVISIA است. او تقریباً بیست سال در زمینه فناوری برای انواع مشتریان در چندین صنعت مختلف کار کرده است. او علاقه زیادی به تدریس و راهنمایی دارد. پانزده دقیقه از شهرت او رسیدن به سطل شماره 3 در نمایشگاه بوزو بود. وی دارای مدرک لیسانس علوم کامپیوتر و سیستم های اطلاعاتی از دانشگاه DePaul است و در حال حاضر در منطقه شهری شیکاگو اقامت دارد.