Swagger : API Documentation

In this tutorial, we’ll be learning how to add swagger to existing Node Js and Express.js. Video : Swagger: API Documentation and now we will add swagger in this project.

+

The source code for the final project can be found here. Github : https://github.com/mvndr/swagger

Before we start please find below important technologies definitions

1. SWAGGER — Swagger is an open-source software framework backed by a large ecosystem of tools that helps developers design, build, document, and consume RESTful web services
2. Swagger provides a set of great tools for designing APIs and improving the work with web services

a) Swagger Editor — The Swagger Editor is an open-source editor to design, define and document RESTful APIs in the Swagger Specification

b) Swagger Codegen — Swagger Codegen is an open-source project which allows the generation of API client libraries (SDK generation), server stubs, and documentation automatically from an OpenAPI Specification.

c) Swagger UI — Swagger UI allows the development team to visualize and interact with the API’s resources without having any of the implementation logic in place.his UI presentation of the APIs is user friendly and easy to understand, with all logic complexity kept behind the screen.

d) Swagger Inspector — a tool for testing and auto-generating OpenAPI documentation for any API. Swagger Inspector allows you to easily validate and test APIs with no limits on what you test. Tests are automatically saved in the cloud with simple access.

3. The OpenAPI Specification, originally known as the Swagger Specification, is a specification for machine-readable interface files for describing, producing, consuming, and visualizing RESTful web services.

Github : https://github.com/mvndr/swagger

Cheers!!