swagger-jsdoc
Advanced tools
Comparing version 6.0.6 to 6.0.7
{ | ||
"name": "swagger-jsdoc", | ||
"description": "Generates swagger doc based on JSDoc", | ||
"version": "6.0.6", | ||
"version": "6.0.7", | ||
"engines": { | ||
@@ -6,0 +6,0 @@ "node": ">=12.0.0" |
@@ -50,12 +50,8 @@ # swagger-jsdoc | ||
## Node.js version requirements, CommonJS and ESM | ||
## System requirements | ||
`swagger-jsdoc` 6.x requires Node.js 12.x and above. When using the CLI, the library will attempt to load the definition file in several formats: `.js`, `.cjs`, `.yaml` (or `.yml`) and `.json`. | ||
- Node.js 12.x or higher | ||
The example above follows the CommonJS format, which will work when you do not have `"type": "module"` in your `package.json`. | ||
You are viewing `swagger-jsdoc` v6 which is published in CommonJS module system. | ||
However, if you're using ESM and have `"type": "module"`, then please change the extension to `.cjs`. | ||
Definition files in `.js` and ESM will be supported in `swagger-jsdoc` 7.x. | ||
## Installation | ||
@@ -80,2 +76,6 @@ | ||
Detailed documentation is available within [`/docs`](https://github.com/Surnet/swagger-jsdoc/tree/master/docs/README.md) folder. | ||
Click on the version you are using for further details: | ||
- [7.x](https://github.com/Surnet/swagger-jsdoc/tree/v7/docs) | ||
- [6.x](https://github.com/Surnet/swagger-jsdoc/tree/v6/docs) | ||
- [5.x](https://github.com/Surnet/swagger-jsdoc/tree/v5) |
68435