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:
This class does not cover:
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.
Answer these questions about the YAML format.
Answer these questions about the Open API Specification format.
Answer these questions about schemas.
Answer these questions about the Open API Specification
Links to resources on Swagger and alternatives.
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.