Learn Swagger and the Open API Specification
4.3 (1,315 ratings)
Course Ratings are calculated from individual students’ ratings and a variety of other signals, like age of rating and reliability, to ensure that they reflect course quality fairly and accurately.
7,116 students enrolled

Learn Swagger and the Open API Specification

API Definition Files, Tools, and Documentation (OAS 2.0)
Bestseller
4.3 (1,315 ratings)
Course Ratings are calculated from individual students’ ratings and a variety of other signals, like age of rating and reliability, to ensure that they reflect course quality fairly and accurately.
7,116 students enrolled
Created by Peter Gruenbaum
Last updated 1/2020
English
English, Polish [Auto-generated]
Current price: $23.99 Original price: $34.99 Discount: 31% off
5 hours left at this price!
30-Day Money-Back Guarantee
This course includes
  • 1 hour on-demand video
  • 3 articles
  • 10 downloadable resources
  • Full lifetime access
  • Access on mobile and TV
  • Assignments
  • Certificate of Completion
Training 5 or more people?

Get your team access to 4,000+ top Udemy courses anytime, anywhere.

Try Udemy for Business
What you'll learn
  • 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.
Requirements
  • You should understand how REST APIs work
  • You should be able to read and understand JSON
  • If you need these skills, take my courses on JSON/XML and REST
Description

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.

Who this course is for:
  • Anyone who wants to be able to read or write Open API Specification (Swagger) files
  • Project managers
  • Technical writers
  • Technical sales staff
  • Technically-skilled managers
Course content
Expand all 13 lectures 01:05:28
+ Introduction
3 lectures 19:18

Covers:

  • API Definitions
  • What is a REST API?
  • Prerequisites
  • Swagger
  • The Open API Initiative
  • Course Overview
Preview 07:13

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
Preview 05:33
Covers:
  • How YAML is used with the Open API Specification
  • What is YAML?
  • Rules of YAML
YAML
06:32

Answer these questions about the YAML format.

YAML
3 questions
Write a simple YAML file
YAML
1 question
+ Open API Specification
5 lectures 34:56
Note about OAS 3
00:09
Covers:
  • What applies to the entire API
  • What applies to a simple request
  • Path, method, query and parameters, headers
  • Using the Swagger editor
Open API Specification Basics
05:49

Answer these questions about the Open API Specification format.

OAS Basics
3 questions
Create a basic Open API Specification file
Open API Specification Basics
1 question

Covers:

  • What is a schema?
  • References
  • Request bodies
  • Response bodies
Schemas
09:19

Answer these questions about schemas.

Schemas
3 questions
Add schemas to your OAS files for request and response bodies
Schemas
1 question

Covers:

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

Answer these questions about the Open API Specification

Open API Specification, Continued
3 questions
Add more pieces to your Open API Specification file
Open API Specification Continued
1 question

Covers:

  • What autogenerated documentation is
  • How autogenerated documentation looks 
  • How to add description tags
Documentation
08:29
Add documentation to your Open API Specification File
Documentation
1 question
+ Tools and Alternatives
5 lectures 11:14
Covers:
  • Swagger editor
  • Swagger CodeGen
  • Swagger UI (Autogenerated documentation)
  • Core tooling
  • SwaggerHub
Swagger Tools
03:26
Try out SwaggerHub to publish an API
SwaggerHub
1 question
Covers:
  • Why JSON over YAML?
  • How to construct JSON OAS files
JSON
02:37
Start from scratch and create an OAS file given sample requests and responses.
Put It All Together
1 question
Covers:
  • Alternatives to Swagger
  • DapperDox, Swagger UI variants, ReadMe.io, StopLight.io
  • Alternatives to OAS
  • RAML,  API Blueprint
  • Resources
Alternatives to Swagger and OAS
04:50
Create an Open API Specification file for a piece of the Stripe API.
Swagger for a Real World API
1 question

Links to resources on Swagger and alternatives.

Resources
00:09
Bonus Lecture: Offers for Other Courses
00:11