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

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

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

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

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

• مقدمه Introduction

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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