آموزش نگارش فنی: نحوه نوشتن اسناد نرم افزار API

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

معرفی Introduction

• معرفی Introduction

• یک API چیست؟ What is an API

• اسلایدهای مورد استفاده در این بخش Slides Used in This Section

• مزایای استفاده از API Benefits from Using an API

• چه چیزی یاد خواهید گرفت؟ What will you learn?

• API چیست؟ What is an API?

• چگونه یک API کار می کند How Does an API Work

• مزایای استفاده از API Benefits from using an API

• چه کسی مستندات API و API را ایجاد می کند Who Creates API and API Documentation

• یک API چگونه کار می کند؟ How does an API work?

• چه کسی اسناد API و API را ایجاد می کند؟ Who creates API and API documentation?

• مستندات API چیست؟ What is an API documentation?

• انواع API ها Types of APIs

• چه کسی اسناد API را می خواند؟ Who reads API documentation?

• اسناد API - نمونه ها API documentation - examples

• چارچوب اسناد API API documentation framework

• اسناد API - ساختار API documentation - structure

• مرحله 1 Step 1

• مرحله 2 Step 2

• مرحله 3 Step 3

• تست تماس API Testing an API call

نوشتن اسناد API با استفاده از Swagger UI Writing API Documentation Using Swagger UI

• نوشتن اسناد API با استفاده از Swagger UI Writing API documentation using Swagger UI

• اسلایدهای مورد استفاده در این بخش Slides Used in This Section

• دستور کار Agenda

• Swagger چیست؟ What is Swagger?

• مزایای استفاده از Swagger برای نوشتن اسناد API Benefits from using Swagger for writing API documentation

• مرحله 1: ایجاد API جدید Step 1: create new API

• نسخه ی نمایشی Demo

• مرحله 2: صفحه معرفی API را ایجاد کنید Step 2: create the API introductory page

• مرحله 2.1: اطلاعات API را ویرایش کنید Step 2.1: edit the API info

• نمونه اطلاعات مقدماتی Sample introductory info

• نسخه ی نمایشی Demo

• مرحله 2.2: مخاطبین و پیوندهای API را برای اسناد بیشتر ویرایش کنید Step 2.2: edit the API contacts and links to further documentation

• نمونه مخاطبین و لینک اسناد Sample contacts and documentation link

• مرحله 3: تگ های API خود را تعریف کنید Step 3: define the tags of your API

• مرحله 4: عملیات و مسیرهای API را تعریف کنید Step 4: define the API operations and paths

• نمونه عملیات API و مسیر Sample API operation and path

• نسخه ی نمایشی Demo

• مرحله 5: پارامترهای API را مستند کنید Step 5: document the API parameters

• پارامترهای نمونه Sample parameters

• مرحله 6: پاسخ های API را مستند کنید Step 6: document the API responses

• نمونه پاسخ Sample response

• مرحله 7: اسناد API را صادر کنید Step 7: export the API documentation

چارچوب مستند سازی API API Documentation Framework

• اسناد API چیست؟ What is an API Documentation

• انواع API ها Types of APIs

• چه کسی مستندات API را می خواند Who Reads API Documentation

• اسناد API - نمونه ها API Documentation - Examples

• اسناد API - چارچوب نوشتن API Documentation - a Framework for Writing

• اسناد API - ساختار API Documentation - Structure

• مرحله 1 - دسترسی به API Step 1 - Accessing the API

• مرحله 2 - پاسخ های API Step 2 - API Responses

• مرحله 3 - درخواست ها Step 3 - Requests

نوشتن اسناد API با استفاده از صفحات ویکی Postman و GitHub Writing API Documentation Using Postman and GitHub Wiki Pages

• معرفی بخش Section introduction

• در این بخش چه چیزی یاد خواهید گرفت؟ What will you learn in this section?

• ابزارهایی که استفاده خواهیم کرد Tools we will use

• داستان چیست؟ What's the story?

• پستچی چیست؟ What is Postman?

• دانلود و آشنایی با پستچی Downloading and getting to know Postman

• با استفاده از Postman، استفاده از Stripe API را مستند کنید Using Postman, document the usage of the Stripe API

• مرحله 1 Step 1

• مرحله 2 - قسمت 1 Step 2 - part 1

• مرحله 2 - قسمت 2 Step 2 - part 2

• مرحله 3 Step 3

• مرحله 4 Step 4

• مرحله 5 Step 5

ابزار توسعه دهندگان مستندات API Tools for API Documentation Developers

• پستچی - یک ابزار برای استفاده از APIs Postman - a Tool for Using APIs

• 16 16

بخش پاداش Bonus Section

• 17 17

• یک خلاصه A Recap