آموزش مستندسازی خدمات RESTful با استفاده از Spring REST Docs 3

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

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

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

ارائه مستندات برای API های RESTful Providing Documentation for RESTful APIs

• معرفی Introduction

• بررسی اجمالی کد نمونه Overview of the Sample Code

• راه اندازی یک پروژه Spring REST Docs Setting up a Spring REST Docs Project

• نسخه ی نمایشی: راه اندازی پروژه Demo: Project Setup

• گزینه های پیکربندی اسناد Spring REST Spring REST Docs Configuration Options

• وب‌سایت‌های مستندسازی با اسناد Spring REST Documentation Websites with Spring REST Docs

• نسخه ی نمایشی: وب سایت اسناد NekoShlink Demo: NekoShlink Documentation Website

• خلاصه Summary

یکپارچه سازی مستندات و تست Integrating Documentation and Testing

• بررسی اجمالی چارچوب های تست Testing Frameworks Overview

• Spring Mock MVC Spring Mock MVC

• نسخه ی نمایشی: Spring Mock MVC Demo: Spring Mock MVC

• سرویس گیرنده تست وب بهار Spring Web Test Client

• نسخه ی نمایشی: سرویس گیرنده تست وب بهار Demo: Spring Web Test Client

• مطمئن باش RestAssured

• نسخه ی نمایشی: مطمئن باشید Demo: RestAssured

• خلاصه Summary

مستندسازی درخواست و پاسخ Documenting Request and Response

• مستندسازی ویژگی های HTTP Documenting HTTP Features

• نسخه ی نمایشی: فیلدهای پاسخ Demo: Response Fields

• نسخه ی نمایشی: مسیرهای فرعی فیلد پاسخ Demo: Response Field Subpaths

• نسخه ی نمایشی: فیلدهای درخواست Demo: Request Fields

• نسخه ی نمایشی: متغیرهای مسیر Demo: Path Variables

• نسخه ی نمایشی: رشته های پرس و جو Demo: Query Strings

• نسخه ی نمایشی: سرصفحه های HTTP Demo: HTTP Headers

• استفاده مجدد از تعاریف قطعه Reusing Snippet Definitions

• نسخه ی نمایشی: استفاده مجدد از تعاریف قطعه Demo: Reusing Snippet Definitions

• خلاصه Summary

پیکربندی و سفارشی کردن اسناد شما Configuring and Customizing Your Documentation

• قالب های قطعه Snippet Formats

• محدودیت های میدانی Field Constraints

• الگوهای اسنیپت Snippet Templates

• الگوهای قطعه سفارشی Custom Snippet Templates

• نسخه ی نمایشی: استفاده از الگوهای سفارشی برای محدودیت های فیلد Demo: Using Custom Templates for Field Constraints

• نسخه ی نمایشی: استفاده از الگوهای سفارشی برای پارامترهای پرس و جو Demo: Using Custom Templates for Query Parameters

• پیکربندی قطعات پیش فرض Configuring the Default Snippets

• پیش پردازشگرهای درخواست و پاسخ Request and Response Preprocessors

• نسخه ی نمایشی: پیکربندی پیش فرض قطعات Demo: Default Snippets Configuration

• نسخه ی نمایشی: پیش پردازشگرهای درخواست و پاسخ Demo: Request and Response Preprocessors

• خلاصه Summary

تکمیل اسناد خود با AsciiDoc یا Markdown Finalizing Your Documentation with AsciiDoc or Markdown

• AsciiDoc AsciiDoc

• قالب بندی پایه Basic Formatting

• لیست های AsciiDoc AsciiDoc Lists

• اطلاعات بیشتر در مورد AsciiDoc Lists More on AsciiDoc Lists

• جداول AsciiDoc AsciiDoc Tables

• از جمله فایل ها و ایجاد فهرست مطالب Including Files and Creating Table of Contents

• استفاده از AsciiDoc با اسناد Spring REST AsciiDoc Usage with Spring REST Docs

• نسخه ی نمایشی: ایجاد وب سایت AsciiDoc Demo: Creating the AsciiDoc Website

• نسخه ی نمایشی: AsciiDoc و DocInfo Demo: AsciiDoc and DocInfo

• نسخه ی نمایشی: AsciiDoc و ویژگی های گزینه Demo: AsciiDoc and Option Attributes

• نسخه ی نمایشی: مرور وب سایت نهایی Demo: Browsing the Final Website

• خلاصه Summary

ایجاد مشتریان REST از طریق OpenAPI با restdocs-api-spec Generating REST Clients through OpenAPI with restdocs-api-spec

• مقدمه ای بر OpenAPI Introduction to OpenAPI

• استفاده از OpenAPI در Spring Boot با SpringDoc Using OpenAPI in Spring Boot with SpringDoc

• نسخه ی نمایشی: Spring Doc Demo: Spring Doc

• OpenAPI در مقابل Spring REST Docs OpenAPI vs. Spring REST Docs

• همه چیز را با مشخصات API REST Docs همراه کنید Bringing It All Together with REST Docs API Spec

• نسخه ی نمایشی: پروژه را برای REST Docs API Spec آماده کنید Demo: Prepare the Project for REST Docs API Spec

• نسخه ی نمایشی: پروژه را با مشخصات REST Docs API اجرا کنید Demo: Run the Project with REST Docs API Spec

• خلاصه و جمع بندی Summary and Wrap-up