Learn Swagger And The Open Api Specification

API Definition Files, Tools, and Documentation (OAS 2.0)

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) filesThe YAML file formatHow to create an OAS fileHow to specify securityHow to add documentationHow to write an OAS file in JSONAlternatives to Swagger and OASThis class does not cover:How to set up Swagger on your own serverHow to modify Swagger open source codeIn 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, expect to spend at least 4 hours doing the exercises. These exercises are key to understanding Swagger and OAS.Important: The course uses OAS 2. A newer version, OAS 3, is starting to be used more, but  many companies are still using OAS 2. There is a lecture that points you to the differences between OAS 2 and OAS 3.

Overview

Section 1: Introduction

Lecture 1 Introduction

Lecture 2 API Definition

Lecture 3 YAML

Section 2: Open API Specification

Lecture 4 Note about OAS 3

Lecture 5 Open API Specification Basics

Lecture 6 Schemas

Lecture 7 Open API Specification Continued

Lecture 8 Documentation

Section 3: Tools and Alternatives

Lecture 9 Swagger Tools

Lecture 10 JSON

Lecture 11 Alternatives to Swagger and OAS

Lecture 12 Resources

Lecture 13 Bonus Lecture: Offers for Other Courses

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