swagger-explorer README
This project helps you to work with Swagger API documentation in Visual Studio Code.
Contribution
Do you like this project? Support it by donating, creating an issue or pull request.
Features
This extensions helps you to browse yours per project Swagger or OpenAPI endpoints:
Requirements
No dependencies required
Getting Started
To start to use this extension you need to add a config file (normally swaggerexplorer.config.json) in your project and add this settings:
{
"sources": [
{
"label": "Sample of Swagger (Pet Store)",
"url": "https://petstore.swagger.io/v2/swagger.json"
}
]
}
The "url" is the json url visible in the SwaggerUI:
Extension Settings
This extension contributes the following settings:
swaggerExplorer.configFilePattern: pattern to find the config file in the project, now supports multiple files: **/swaggerexplorer.config.json;**/swexp.config.jsonswaggerExplorer.httpTimeout: milliseconds to timeout http(s) callsswaggerExplorer.validateSource: a boolean that tells parser to validate the source during parsingswaggerExplorer.allowInvalidCertificates: a boolean that allow unsecure https urls. WARNING! use it at your own riskswaggerExplorer.loggerVerbosity: sets the verbosity for the output panel logs
This extension works with OpenAPI v3 documents and uses the swagger2openapi npm library to convert swagger v2 json into OpenAPI v3 document.
Known Issues
Actually you can only browse the endpoints tree and the DTOs (schemas).
Third party libraries
dependencies defined in package.json:
Release Notes
0.0.11
- Updated some dependencies
0.0.10
- Added config to allow invalid certificates for remote json through https
- Fixed logger verbosity
0.0.9
- Configurable logger verbosity
- Sorted tree items
0.0.8
- Add new source button
- Multiple config file in the same project now have different tree items
0.0.7
- Swagger files are now cached
0.0.5
- Added support for multiple file patterns in Settings
0.0.4
Changelog
Show the changelog
