All Projects → arjun-g → Vs Swagger Viewer

arjun-g / Vs Swagger Viewer

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

Programming Languages

typescript
32286 projects

Projects that are alternatives of or similar to Vs Swagger Viewer

Vscode Apielements
VSCode extensions for API Elements (aka: API Blueprint and Swagger)
Stars: ✭ 117 (-7.14%)
Mutual labels:  swagger, vscode, vscode-extension
Vscode
Unibeautify for VSCode
Stars: ✭ 110 (-12.7%)
Mutual labels:  vscode, vscode-extension
Vscode Js Annotations
Javascript / Typescript Parameter Annotations for Visual Studio Code
Stars: ✭ 110 (-12.7%)
Mutual labels:  vscode, vscode-extension
Grpc Gateway
The gRPC-Gateway is a plugin of the Google protocol buffers compiler protoc. It reads protobuf service definitions and generates a reverse-proxy server which translates a RESTful HTTP API into gRPC. This server is generated according to the google.api.http annotations in your service definitions.
Stars: ✭ 12,223 (+9600.79%)
Mutual labels:  swagger, openapi
Wizard
Wizard是一款开源的文档管理工具,支持Markdown/Swagger/Table类型的文档。
Stars: ✭ 1,733 (+1275.4%)
Mutual labels:  swagger, openapi
Webapiclient
An open source project based on the HttpClient. You only need to define the c# interface and modify the related features to invoke the client library of the remote http interface asynchronously.
Stars: ✭ 1,618 (+1184.13%)
Mutual labels:  swagger, openapi
Vscode Azure Blockchain Ethereum
Blockchain extension for VS Code
Stars: ✭ 111 (-11.9%)
Mutual labels:  vscode, vscode-extension
Vscode Winteriscoming
Dark theme with fun and bright foreground colors
Stars: ✭ 105 (-16.67%)
Mutual labels:  vscode, vscode-extension
Vscode Language Pascal
Pascal language extension for Visual Studio Code
Stars: ✭ 117 (-7.14%)
Mutual labels:  vscode, vscode-extension
Vscode Go
Go extension for Visual Studio Code
Stars: ✭ 2,268 (+1700%)
Mutual labels:  vscode, vscode-extension
Http Router
🎉 Release 2.0 is released! Very fast HTTP router for PHP 7.1+ (incl. PHP8 with attributes) based on PSR-7 and PSR-15 with support for annotations and OpenApi (Swagger)
Stars: ✭ 124 (-1.59%)
Mutual labels:  swagger, openapi
Openapi Core
OpenAPI core
Stars: ✭ 119 (-5.56%)
Mutual labels:  swagger, openapi
Flowmaker
flowmaker: JS to SVG flowchart generation extension for Vscode in realtime written in typescript and also download the SVG through local node server. Extension:
Stars: ✭ 108 (-14.29%)
Mutual labels:  vscode, vscode-extension
Vscode Ptt
在 VSCode 瀏覽 PTT!
Stars: ✭ 110 (-12.7%)
Mutual labels:  vscode, vscode-extension
Vscode Solidity Auditor
Solidity language support and visual security auditor for Visual Studio Code
Stars: ✭ 108 (-14.29%)
Mutual labels:  vscode, vscode-extension
I18n Ally
🌍 All in one i18n extension for VS Code
Stars: ✭ 1,931 (+1432.54%)
Mutual labels:  vscode, vscode-extension
Vscode Yuml
yUML extension for Visual Studio Code
Stars: ✭ 102 (-19.05%)
Mutual labels:  vscode, vscode-extension
Vscode Mdx Preview
MDX Preview for Visual Studio Code
Stars: ✭ 103 (-18.25%)
Mutual labels:  vscode, vscode-extension
Vscode Postgres
PostgreSQL extension for vscode providing explorer, highlighting, diagnostics, and intellisense
Stars: ✭ 117 (-7.14%)
Mutual labels:  vscode, vscode-extension
L5 Swagger
OpenApi or Swagger integration to Laravel
Stars: ✭ 1,781 (+1313.49%)
Mutual labels:  swagger, openapi

Marketplace Version Marketplace Downloads

ko-fi

Swagger Viewer - v3.0.0

Swagger Viewer lets you preview Swagger 2.0 and OpenAPI files as you type in Visual Studio Code. Additionally provide intellisense/linting for the files as well.

It works on swagger files in json and yaml format. Preview 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

Swagger Preview

Swagger Context Menu

Configurations

Swagger Settings

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

Stop Swagger Viewer Preview Server

To stop the preview server simply click the status bar item.

Stop Swagger Server

Releases

v3.0.0 Changes

  • The primary functionality of the Swagger Viewer extension would be the ability to preview Swagger and OpenAPI files.
  • Swagger Viewer will just use the json schema of Swagger and OpenAPI to provide intellisense and linting. Recommend using teh extension OpenAPI (Swagger) Editor for full editing capabilities.
  • Intellisense for Swagger 2.0 and OpenAPI 3.0 is available now. Added extension YAML as extensionDependencies for supporting YAML intellisense.
  • Default port changed to 18512
  • Upgraded swagger-ui to version 3.25.2
  • Start preview server in next available port for preview if configured port is not available
  • Fix for custom host config
  • Ability to stop the preview server

v2.2.2 Changes

v2.2.1 Changes

  • Fixed the external refs issue #45

Known Issue

  • Validator still gives a warning on relative paths. Will be fixed in next version.

v2.2.0 Changes

v2.1.0 Changes

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 https://github.com/arjun-g/vs-swagger-viewer/pull/36
  • Multiple minor bug fixes

v1.7.0 Changes

v1.6.0 Changes

v1.5.0 Changes

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

v1.2.0 Changes

Credits

Swagger Viewer utilizes the following open source projects

Contributors

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].