Swagger tutorial -- How to add Swagger OpenAPI to your REST API documentation

; Date: Mon Jan 09 2017

Tags: OpenAPI

An introduction to Swagger/OpenAPI. A core idea given is documentation that's interactive, and unlike typical documentation as it appears in a slide deck. The power of having an API described in an industry-standard format is the wide variety of tools available.

The Swagger Editor ( (swagger.io) http://swagger.io/swagger-editor/) interactively verifies the OpenAPI spec file.

Generating the Swagger Spec for your API, done either "manually" (editing it yourself), or automatically by annotations in your source code.

Swagger UI ( (swagger.io) http://swagger.io/swagger-ui/) parses the API spec, letting you browse it in a web browser

About the Author(s)

David Herron : David Herron is a writer and software engineer focusing on the wise use of technology. He is especially interested in clean energy technologies like solar power, wind power, and electric cars. David worked for nearly 30 years in Silicon Valley on software ranging from electronic mail systems, to video streaming, to the Java programming language, and has published several books on Node.js programming and electric vehicles.