Module 06 of 10

OpenAPI & Documentation

Lessons

About This Module

An API is only as useful as people's ability to understand it. This module shows how to describe your API in a standard, machine-readable way and turn that description into documentation that developers can actually read and try out.

It starts with the OpenAPI Specification: what it is, how it relates to Swagger, and how a YAML or JSON file describes paths, parameters, request bodies, responses, and security schemes. From there it covers the tooling around it, including Swagger UI and Swagger Editor for interactive documentation, and how a single contract keeps your docs, tests, and client code in sync.

Watch the lessons in order, then continue on to Versioning & Evolution, where you'll learn how to change an API over time without breaking the people who depend on it.

Lessons

4 videos
01

Swagger Tutorial: From Basics to Interactive API Docs

An introduction to Swagger as a tool and specification for documenting REST APIs, including how it was renamed the OpenAPI Specification.

02

Swagger API Documentation Tutorial

A step-by-step tutorial on using Swagger to create interactive API documentation from the OpenAPI Specification.

03

OpenAPI Specification Using Postman

A demonstration of creating an OpenAPI Specification for a REST API using Postman.

04

API Status Codes and OpenAPI Documentation

A look at documenting API responses and status codes in OpenAPI, so every outcome of an endpoint is clearly described.