Swagger Doc Viewer

Viewer documentation for a OpenAPI Specification (fka The Swagger Specification).

Note

This project is still a work in progress.

Features

• Displays documentation API specification in a browser (http://localhost:9000) using SwaggerEditor.
• The browser automatically refresh with changes in Visual Studio Code through socket communication SocketIO.
• Used a Express server for a correct working to $ref. The base path is used to indicate the static folder containing references to the main Swagger file.
• Routes used in the $ref are relative to the main Swagger file.

Requirements

Visual Studio Code

Usage

• Open the main Swagger file.
• Run the Command ⇧⌘P Swagger Doc Viewer.

3rd Party Libraries/Frameworks

• SwaggerEditor
• SocketIO
• Express