آموزش مشخصات OpenAPI: اسناد API Redocly

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

معرفی Introduction

• معرفی دوره Course Introduction

• معرفی مربی Instructor Introduction

• بیشترین بهره را از دوره خود ببرید Getting the Most Out of Your Course

• تنظیم محیط توسعه شما Setting Up Your Development Environment

• نصب و راه اندازی محیط توسعه Development Environment Installation

• اتاق شلوغ دوره - با مربی خود و سایر دانش آموزان گپ بزنید Course Slack Room - Chat with Your Instructor and Other Students

مقدمه ای بر Redoc Introduction to Redoc

• معرفی Introduction

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

• طرحواره OpenAPI و مشخصات مثال OpenAPI Schema and Example Specification

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

• نسخه ی نمایشی مجدد Redoc Demo

• ویژگی های Redoc Redoc Features

• نسخه نمایشی تصویر Redoc Docker Redoc Docker Image Demo

• میزبانی Redoc در صفحات Github Hosting Redoc On Github Pages

• مشکلات کش کردن در صفحات Github Problems With Cacheing on Github Pages

مقدمه ای بر Redocly Introduction to Redocly

• معرفی Introduction

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

• ایجاد یک حساب کاربری مجدد Creating a Redocly Account

• شروع سریع را مجدداً تکرار کنید Redocly Quick Start

• بررسی کد شروع سریع Redocly Redocly Quick Start Code Review

• API را به Redocly Registry اضافه کنید Add API to Redocly Registry

• تکلیف - ایجاد رجیستری API جدید Assignment - Create New API Registry

• به روز رسانی Github Dependbot Github Dependbot Updates

• ایجاد شعبه نسخه Create Version Branch

مدیریت مشخصات OpenAPI با Redocly Managing OpenAPI Specs With Redocly

• معرفی Introduction

• به روز رسانی به SFG Brewery Specification Update to SFG Brewery Specification

• مشخصات Rebilly OpenAPI Rebilly OpenAPI Specification

• Redocly CLI را نصب کنید Install Redocly CLI

• استفاده از Redocly Split Using Redocly Split

• پسوند کد Redocly VS Code Redocly VS Code Extension

• مشخصات OpenAPI خود را تأیید کنید Verify Your OpenAPI Specification

• اسناد Redoc API را به صورت محلی مشاهده کنید View Redoc API Documentation Locally

• مشخصات OpenAPI خود را به صورت محلی بسته بندی کنید Bundle Your OpenAPI Specification Locally

با استفاده از Markdown Using Markdown

• معرفی Introduction

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

• استفاده از سرفصل های Markdown Using Markdown Headings

• پررنگ و کج Bold and Italics

• لیست های مرتب و نامرتب Ordered and Unordered Lists

• اضافه کردن بلوک های کد Adding Code Blocks

• اضافه کردن هایپرلینک ها Adding Hyperlinks

پسوندهای OpenAPI را مجدداً بررسی کنید Redocly OpenAPI Extensions

• معرفی Introduction

• اضافه کردن لوگو به مستندات Redocly Add Logo to Redocly Documentation

• استفاده از Tag Groups Using Tag Groups

• اضافه کردن توضیحات Enum Adding Enum Descriptions

• پنل Try-it را پنهان کنید Hide Try-it Pannel

با استفاده از Try It API Console Using Try It API Console

• معرفی Introduction

• سعی کنید آن را تظاهرات Try-It Demonstration

قوانین Reocly Redocly Rules

• معرفی Introduction

• بررسی اجمالی قوانین Redocly Redocly Rules Overview

• ساخته شده در قوانین Redocly Built In Redocly Rules

• استفاده از Built In Redocly Rules Using Built In Redocly Rules

• Reocly شکست قانون گردش کار Redocly Workflow Rule Failures

• مجموعه قوانین Reocly Redocly Rule Sets

• راهنمای سبک API API Style Guide

Redocly API Decorators Redocly API Decorators

• معرفی Introduction

• نمای کلی API Decorators API Decorators Overview

• API Decorators مثال API Decorators Example

نسخه های API API Versions

• معرفی Introduction

• چه زمانی API خود را نسخه کنید When to Version Your API

• استراتژی‌های نسخه‌سازی مجدد Redocly Versioning Strategies

• نسخه بندی مشخصات OpenAPI منفرد Versioning Single OpenAPI Specification

• نسخه ریشه فایل Root File Versioning

پیوست اول Appendix A

• مبانی Git و GitHub - از اینجا شروع کنید! Git and GitHub Basics - Start Here!