4.31 out of 5
4.31
554 reviews on Udemy

Learn Swagger and the Open API Specification

API Definition Files, Tools, and Documentation
Instructor:
Peter Gruenbaum
2,968 students enrolled
English More
Read and write Open API Specification (Swagger) files to define and document APIs
Use Swagger tools to edit files, create documentation, and create SDKs
Understand alternatives to Swagger and OAS.

The Open API Specification (often called “Swagger”) is currently the most popular way to create definitions of RESTful APIs. With these definitions, you can create sophisticated, autogenerated documentation, generate SDKs in several languages, and do automated testing. Swagger is a set of open source tools that use these Open API Specification definition files.

This class is for people in the software industry who are fairly technical, but are not software developers: for example, project managers, API product managers, and technical writers. It assumes that you understand REST and JSON, but that’s about all. It is meant to be for people who are new to the Open API Specification and Swagger, rather than for experts. It covers:

  • What you can do with Open API Specification (OAS) files

  • The YAML file format

  • How to create an OAS file

  • How to specify security

  • How to add documentation

  • How to write an OAS file in JSON

  • Alternatives to Swagger and OAS

This class does not cover:

  • How to set up Swagger on your own server

  • How to modify Swagger open source code

In addition to videos, this course contains 8 hands-on exercises that lead you step-by-step in creating an API definition file, including a final project where you create a file from scratch using documentation from an actual commercial API. It also contains a document with resources on learning more about OAS, Swagger, and alternatives.

In addition to the video lectures, except to spend at least 4 hours doing the exercises. These exercises are key to understanding Swagger and OAS.

Note: The course describes OAS 2. A newer version, OAS 3, has become available recently. At some point the course will be updated to reflect OAS 3.

Introduction

1
Introduction

Covers:

  • API Definitions
  • What is a REST API?
  • Prerequisites
  • Swagger
  • The Open API Initiative
  • Course Overview
2
API Definition

Covers:

  • What’s an API Definition File?
  • Anatomy of an API Request
  • What’s in an API Definition File?
  • Getting Information to create an API Definition File
3
YAML
Covers:
  • How YAML is used with the Open API Specification
  • What is YAML?
  • Rules of YAML
4
YAML

Answer these questions about the YAML format.

5
YAML

Open API Specification

1
Note about OAS 3
2
Open API Specification Basics
Covers:
  • What applies to the entire API
  • What applies to a simple request
  • Path, method, query and parameters, headers
  • Using the Swagger editor
3
OAS Basics

Answer these questions about the Open API Specification format.

4
Open API Specification Basics
5
Schemas

Covers:

  • What is a schema?
  • References
  • Request bodies
  • Response bodies
6
Schemas

Answer these questions about schemas.

7
Schemas
8
Open API Specification Continued

Covers:

  • Security
  • Error Conditions
  • Content types (JSON, JPEG, etc.)
  • Operation IDs
9
Open API Specification, Continued

Answer these questions about the Open API Specification

10
Open API Specification Continued
11
Documentation

Covers:

  • What autogenerated documentation is
  • How autogenerated documentation looks 
  • How to add description tags
12
Documentation

Tools and Alternatives

1
Swagger Tools
Covers:
  • Swagger editor
  • Swagger CodeGen
  • Swagger UI (Autogenerated documentation)
  • Core tooling
  • SwaggerHub
2
SwaggerHub
3
JSON
Covers:
  • Why JSON over YAML?
  • How to construct JSON OAS files
4
Put It All Together
5
Alternatives to Swagger and OAS
Covers:
  • Alternatives to Swagger
  • DapperDox, Swagger UI variants, ReadMe.io, StopLight.io
  • Alternatives to OAS
  • RAML,  API Blueprint
  • Resources
6
Swagger for a Real World API
7
Resources

Links to resources on Swagger and alternatives.

8
Bonus Lecture: Offers for Other Courses
You can view and review the lecture materials indefinitely, like an on-demand channel.
Definitely! If you have an internet connection, courses on Udemy are available on any device at any time. If you don't have an internet connection, some instructors also let their students download course lectures. That's up to the instructor though, so make sure you get on their good side!
4.3
4.3 out of 5
554 Ratings

Detailed Rating

Stars 5
224
Stars 4
224
Stars 3
79
Stars 2
13
Stars 1
15
f5d10600bb3c0dc5a0da4610af94549d
30-Day Money-Back Guarantee

Includes

1 hours on-demand video
3 articles
Full lifetime access
Access on mobile and TV
Certificate of Completion