آموزش API Technical Writing 2: REST for Writers
Learn API Technical Writing 2: REST for Writers
این دومین دوره از سری دوره ها برای نویسندگان فنی است که می خواهند نحوه نوشتن اسناد API را یاد بگیرند. اولین دوره "Learn API Technical Writing: JSON and XML for Writers" نام دارد و توصیه می شود ابتدا آن دوره را بگذرانید، مگر اینکه با JSON و XML و نحوه مستندسازی آنها آشنایی کامل داشته باشید.
این دوره نحوه مستندسازی REST APIها را آموزش می‌دهد. هیچ تجربه برنامه نویسی مورد نیاز نیست، اما نویسندگان فنی با تجربه برنامه نویسی که می خواهند درباره API های REST بیشتر بدانند، همچنان آن را مفید خواهند یافت.
API ها چیست؟
API ها (رابط برنامه های کاربردی) نحوه صحبت سیستم های نرم افزاری با یکدیگر را تعریف می کنند و مستندسازی API یک زمینه به سرعت در حال رشد است. نیاز شدیدی به نویسندگانی وجود دارد که بتوانند API ها را درک کنند و آنها را توضیح دهند تا توسعه دهندگان نرم افزار بتوانند نحوه استفاده از آنها را درک کنند. نویسندگان API می‌توانند در موقعیت‌های پردرآمد در لبه فناوری قرار بگیرند.
REST چیست؟
REST (انتقال وضعیت نمایندگی) یک سبک محبوب وب API است و برای برقراری ارتباط داده ها بین دستگاه ها و سرورها استفاده می شود. داده‌های مختلفی در بخش‌های مختلف درخواست‌ها و پاسخ‌های API وجود دارد، و این دوره توضیح می‌دهد که آن بخش‌های مختلف چیست و چگونه می‌توان آنها را مستند کرد.
در این دوره آموزشی چیست؟
در پایان دوره، متوجه خواهید شد که REST چیست و چگونه درخواست‌ها و پاسخ‌های REST را بخوانید و مستند کنید. در این دوره آموزشی خواهید یافت:
- 12 ویدیو که:
- اطلاعات پس‌زمینه REST APIها را ارائه می‌کند
- درخواست‌های REST را با مثال‌ها به قطعات مختلف تقسیم کنید
- نمایش مستندات REST در زمان واقعی و روایت شده
- مروری بر احراز هویت و مجوز برای REST ارائه دهید
- 7 تمرین عملی برای هدایت شما در ایجاد و مستندسازی درخواست های REST
- 7 آزمون کوتاه که شما را سرحال نگه می دارد
- ارائه های پاورپوینت به عنوان منبعی برای هر سخنرانی ویدیویی
- یک سند مایکروسافت ورد که می توانید از آن به عنوان الگویی برای مطالب مرجع REST استفاده کنید
تکمیل دوره تقریباً 3 ساعت و 30 دقیقه طول می‌کشد، بسته به سرعت انجام تمرین‌ها.
معرفی Introduction
-
معرفی Introduction
-
باقی مانده REST
-
باقی مانده REST
معرفی Introduction
-
معرفی Introduction
-
باقی مانده REST
-
باقی مانده REST
باقی مانده REST
-
درخواست ها Requests
-
درخواست های REST REST requests
-
منابع Resources
-
نام منابع جمع Plural resource names
-
منابع Resources
-
مواد و روش ها Methods
-
مواد و روش ها Methods
-
تمرین 1 -- ایجاد درخواست های REST Exercise 1 -- Making REST requests
-
تمرین 2 -- روش سند و آدرس منبع Exercise 2 -- Document method and resource URL
-
پارامترهای پرس و جو Query Parameters
-
پارامترهای پرس و جو Query Parameters
-
تمرین 3 - درخواست های API را با پارامترهای پرس و جو ایجاد کنید Exercise 3 -- Make API requests with query parameters
-
تمرین 4 - پارامترهای پرس و جو سند Exercise 4 -- Document query parameters
-
سرصفحه ها Headers
-
سرصفحه ها Headers
-
تمرین 5 -- سرصفحه های سند Exercise 5 -- Document headers
-
احراز هویت و مجوز Authentication and Authorization
-
احراز هویت و مجوز Authentication and Authorization
-
درخواست بدن و پاسخ Request Bodies and Responses
-
تمرین 6 - کدهای وضعیت اسناد Exercise 6 -- Document status codes
باقی مانده REST
-
درخواست ها Requests
-
درخواست های REST REST requests
-
منابع Resources
-
نام منابع جمع Plural resource names
-
منابع Resources
-
مواد و روش ها Methods
-
مواد و روش ها Methods
-
تمرین 1 -- ایجاد درخواست های REST Exercise 1 -- Making REST requests
-
تمرین 2 -- روش سند و آدرس منبع Exercise 2 -- Document method and resource URL
-
پارامترهای پرس و جو Query Parameters
-
پارامترهای پرس و جو Query Parameters
-
تمرین 3 - درخواست های API را با پارامترهای پرس و جو ایجاد کنید Exercise 3 -- Make API requests with query parameters
-
تمرین 4 - پارامترهای پرس و جو سند Exercise 4 -- Document query parameters
-
سرصفحه ها Headers
-
سرصفحه ها Headers
-
تمرین 5 -- سرصفحه های سند Exercise 5 -- Document headers
-
احراز هویت و مجوز Authentication and Authorization
-
احراز هویت و مجوز Authentication and Authorization
-
درخواست بدن و پاسخ Request Bodies and Responses
-
تمرین 6 - کدهای وضعیت اسناد Exercise 6 -- Document status codes
همه اش را بگذار کنار هم Putting It All Together
-
همه اش را بگذار کنار هم Putting It All Together
-
تمرین 7 - ایجاد مستندات مرجع کامل Exercise 7 -- Creating full reference documentation
-
ابزارهایی برای اسناد REST Tools for REST Documentation
-
بررسی و مراحل بعدی Review and Next Steps
-
سخنرانی جایزه: پیشنهاد برای دوره بعدی مجموعه Bonus Lecture: Offer for Next Course in the Series
همه اش را بگذار کنار هم Putting It All Together
-
همه اش را بگذار کنار هم Putting It All Together
-
تمرین 7 - ایجاد مستندات مرجع کامل Exercise 7 -- Creating full reference documentation
-
ابزارهایی برای اسناد REST Tools for REST Documentation
-
بررسی و مراحل بعدی Review and Next Steps
-
سخنرانی جایزه: پیشنهاد برای دوره بعدی مجموعه Bonus Lecture: Offer for Next Course in the Series
https://donyad.com/d/19d0b5
Peter Gruenbaum
رئیس، پل SDK
نمایش نظرات