Learn Swagger and the Open API Specification
4.6 (9 ratings)
Instead of using a simple lifetime average, Udemy calculates a course's star rating by considering a number of different factors such as the number of ratings, the age of ratings, and the likelihood of fraudulent ratings.
102 students enrolled
Wishlisted Wishlist

Please confirm that you want to add Learn Swagger and the Open API Specification to your Wishlist.

Add to Wishlist

Learn Swagger and the Open API Specification

API Definition Files, Tools, and Documentation
Best Selling
4.6 (9 ratings)
Instead of using a simple lifetime average, Udemy calculates a course's star rating by considering a number of different factors such as the number of ratings, the age of ratings, and the likelihood of fraudulent ratings.
102 students enrolled
Created by Peter Gruenbaum
Last updated 8/2017
English
Curiosity Sale
Current price: $10 Original price: $35 Discount: 71% off
30-Day Money-Back Guarantee
Includes:
  • 1 hour on-demand video
  • 2 Articles
  • 10 Supplemental Resources
  • Full lifetime access
  • Access on mobile and TV
  • Assignments
  • Certificate of Completion
What Will I 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.
View Curriculum
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 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 7 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 given sample requests and responses. It also contains a document with resources on learning more about OAS, Swagger, and alternatives.

Who is the target audience?
  • 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
Students Who Viewed This Course Also Viewed
Curriculum For This Course
12 Lectures
01:05:34
+
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
4 Lectures 35:03
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:35

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:17
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.
Final Project
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

Links to resources on Swagger and alternatives.

Resources
00:12

Bonus Lecture: Offers for Other Courses
00:12
About the Instructor
Peter Gruenbaum
4.5 Average rating
1,067 Reviews
3,454 Students
5 Courses
President, SDK Bridge

Peter founded SDK Bridge to bring together his love of technology and writing. After 10 years as a software developer, he learned the skill of API writing at Microsoft. Since then, he has worked as an API writer to describe APIs for eCommerce, automobile traffic prediction, electric utilities, mobile phones, and tractors, just to name a few. In addition to API and SDK documentation, he creates video tutorials for software developer audiences. Peter received his BA in Physics from the University of Chicago and his PhD in Applied Physics from Stanford University.