Documenting RESTful APIs Using Swagger and the Open API Specification
The most common type of web API uses REST, and the most popular way to document RESTful APIs is to use the Open API Specification, so that tools like Swagger can automatically generate interactive, web-based documentation. This course covers the YAML data format, how to document RESTful APIs using the Open API Specification, how to use the Swagger editor, and how to publish documentation using SwaggerHub.
Some understanding of REST and JSON are required. This can be through work experience, Peter’s 2017 TC Camp course, or Peter’s online classes at Udemy. JSON and REST will be will be reviewed, but the assumption is that you will already have had exposure to them.
About the workshop leader
Peter Gruenbaum is the president of SDK Bridge, which specializes in API documentation. He founded the company to bring together his love of technology and writing. He has worked as an API writer to describe APIs for eCommerce, automobile traffic prediction, electric utilities, cameras, tractors, and cat humor sites, just to name a few. He has published four online courses on writing API documentation on the Udemy platform. Peter received his BA in Physics from the University of Chicago and his PhD in Applied Physics from Stanford University.
Date and Location: Friday, 26 January 2018, 9:30 a.m. – 5 p.m.
Location: Mission College, Santa Clara, CA
Cost $125. Lunch is provided.