Swagger Viewer - v2.2.0

Swagger Viewer lets you preview and validate Swagger 2.0 and OpenAPI files as you type in Visual Studio Code.

It works on swagger files in json and yaml format. Preview and validation happens in real time as you type.

Preview

To start

• Open the swagger file and press F1.
• Run the Command Preview Swagger.

OR

• Press Shift + Alt + P

OR

• Right click file in explorer panel and click Preview Swagger

THEN

• Preview it in vscode Itself like this

Configurations

Opening In External browser

If you want to preview the changes in external browser change the settings Preview In Browser to true in User/Workspace Settings

THEN

• Run the Command Preview Swagger.

OR

• Press Shift + Alt + P

Preview will be automatically opened in default browser.

Change Default Port

Default port of the preview url can be changed by changing the Default Port value in User/Workspace Settings

Show Only File Name

In the preview title the file name along with the full path is displayed by default. It can be changed to show only the file name by changing the Show Only File Name to true in User/Workspace Settings

Change Default Host

Default host(localhost) of the preview url can be changed by changing the swaggerViewer.defaultHost value in User/Workspace Settings

Validation (Partial)

Swagger Viewer validates your documents against Swagger 2.0 and OpenAPI specifications. If there are any issues it will be shown as a warning in the problems panel. Right now only one validation error will be shown even if there are multiple issues.

TODO

• Show all the errors during validation
• Add code complete support based on Swagger 2.0 and OpenAPI specifications

Releases

v2.2.0 Changes

• Support to configure default preview host (instead of localhost) - By @beastoin arjun-g#41

v2.1.0 Changes

• Replaced the deprecated vscode.previewHtml with Webview - #50
• Added configuration option to show only file name in title
• Added support for OpenAPI 3.0.3 validation - By @ackintosh arjun-g#49

v2.0.2 Changes

• Fixed issues with parsing yaml due in yamljs library. Changed to js-yaml library.
• Fixed issue where validation errors are not cleared in yaml file.

v2.0.0 Changes

• Code base changed to TypeScript
• Partial validation support added
• OpenAPI Support added (Not fully tested)
• Only one server runs for the preview page
• Multiple files can be previewed at a time inside vscode
• Context menu added to the explorer to start the preview directly without opening the file
• Using files from swagger-ui-dist npm package - By @Raptor399 arjun-g#36
• Multiple minor bug fixes

v1.7.0 Changes

• Fixed issue in json file parsing. - By @Zlass arjun-g#27

v1.6.0 Changes

• Added support for .yaml, .yml, .json and unsaved documents. - By @DW8Reaper arjun-g#21

v1.5.0 Changes

• Upgraded Swagger UI v3 for preview. - By @jienco arjun-g#17

v1.4.0 Changes

• Fixed - Preview of JSON Swagger files not getting updated in realtime. - By @tmsns
• Fixed - Preview window in vs code not switching to latest file.
• Added - File name in preview window to identify which file is in preview.
• Some performance fixes

v1.3.0 Changes

• Added - Now preview swagger inside the editor itself. - By @ferreus arjun-g#7
• Added - Preview inside editor by default

v1.2.0 Changes

• Added - Open button in message box. - By @pmentz arjun-g#3
• Added - shortcut Shift + Alt + P to run the command
• Added - Ability to change default port from User/Workspace Settings.

Credits

Swagger Viewer utilizes the following open source projects

• Swagger Editor
• Swagger Parser
• Express
• socket.io
• yaml.js

Contributors

• Patrick Mentz (@pmentz)
• Vladimir Vainer (@ferreus)
• Jonatan Ienco (@jienco)
• @tmsns
• @DW8Reaper
• @Zlass
• @Raptor399
• @ackintosh