swagger-ui-express - npm Package Compare versions

Comparing version 4.0.5 to 4.0.6

package.json

 {
   "name": "swagger-ui-express",
-  "version": "4.0.5",
+  "version": "4.0.6",
   "description": "Swagger UI Express",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

 # Swagger UI Express
 
-Adds middleware to your express app to serve the Swagger UI bound to your Swagger document. This acts as living documentation for your API hosted from within your app.
+This module allows you to serve auto-generated [swagger-ui](https://swagger.io/tools/swagger-ui/) generated API docs from express, based on a `swagger.json` file. The result is living documentation for your API hosted from your API server via a route.
 
 Swagger version is pulled from npm module swagger-ui-dist. Please use a lock file or specify the version of swagger-ui-dist you want to ensure it is consistent across environments.
 
+You may be also interested in:
+
+* [swagger-jsdoc](https://github.com/Surnet/swagger-jsdoc/blob/master/docs/GETTING-STARTED.md): Allows you to markup routes
+with jsdoc comments. It then produces a full swagger yml config dynamically, which you can pass to this module to produce documentation. See below under the usage section for more info.
+* [swagger tools](https://github.com/swagger-api): Various tools, including swagger editor, swagger code gen etc.
+
 ## Usage
@@ -8,0 +14,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17470

increased by3.2%

Number of lines in readme file

221

increased by2.79%

No dependency changes