OpenAPI Specification: Redocly API Documentation

Course Curriculum

Chapter 1: Introduction

Lecture 1: Course Introduction

Lecture 2: Instructor Introduction

Lecture 3: Getting the Most Out of Your Course

Lecture 4: Setting Up Your Development Environment

Lecture 5: Development Environment Installation

Lecture 6: Course Slack Room – Chat with Your Instructor and Other Students

Chapter 2: Introduction to Redoc

Lecture 1: Introduction

Lecture 2: Introduction to OpenAPI

Lecture 3: OpenAPI Schema and Example Specification

Lecture 4: Introduction to Redoc

Lecture 5: Redoc Demo

Lecture 6: Redoc Features

Lecture 7: Redoc Docker Image Demo

Lecture 8: Hosting Redoc On Github Pages

Lecture 9: Problems With Caching on Github Pages

Chapter 3: Introduction to Redocly

Lecture 1: Introduction

Lecture 2: Introduction to Redocly

Lecture 3: Creating a Redocly Account

Lecture 4: Redocly Quick Start

Lecture 5: Redocly Quick Start Code Review

Lecture 6: Add API to Redocly Registry

Lecture 7: Github Dependbot Updates

Lecture 8: Create Version Branch

Chapter 4: Managing OpenAPI Specs With Redocly

Lecture 1: Introduction

Lecture 2: Update to SFG Brewery Specification

Lecture 3: Rebilly OpenAPI Specification

Lecture 4: Install Redocly CLI

Lecture 5: Using Redocly Split

Lecture 6: Redocly VS Code Extension

Lecture 7: Verify Your OpenAPI Specification

Lecture 8: View Redoc API Documentation Locally

Lecture 9: Bundle Your OpenAPI Specification Locally

Chapter 5: Using Markdown

Lecture 1: Introduction

Lecture 2: Introduction to Markdown

Lecture 3: Using Markdown Headings

Lecture 4: Bold and Italics

Lecture 5: Ordered and Unordered Lists

Lecture 6: Adding Code Blocks

Lecture 7: Adding Hyperlinks

Chapter 6: Redocly OpenAPI Extensions

Lecture 1: Introduction

Lecture 2: Add Logo to Redocly Documentation

Lecture 3: Using Tag Groups

Lecture 4: Adding Enum Descriptions

Lecture 5: Hide Try-it Panel

Chapter 7: Using Try It API Console

Lecture 1: Introduction

Lecture 2: Try-It Demonstration

Chapter 8: Redocly Rules

Lecture 1: Introduction

Lecture 2: Redocly Rules Overview

Lecture 3: Built In Redocly Rules

Lecture 4: Using Built In Redocly Rules

Lecture 5: Redocly Workflow Rule Failures

Lecture 6: Redocly Rule Sets

Lecture 7: API Style Guide

Chapter 9: Redocly API Decorators

Lecture 1: Introduction

Lecture 2: API Decorators Overview

Lecture 3: API Decorators Example

Chapter 10: API Versions

Lecture 1: Introduction

Lecture 2: When to Version Your API

Lecture 3: Redocly Versioning Strategies

Lecture 4: Versioning Single OpenAPI Specification

Lecture 5: Root File Versioning

Chapter 11: Appendix A

Lecture 1: Git and GitHub Basics – Start Here!