express-joi-simple - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

package.json

 {
   "name": "express-joi-simple",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -44,2 +44,25 @@ # Express + Joi + Swagger
 Use require instead of import for plain Javascript.
-More complicated example you can find in example folder.
+More complicated example you can find in example folder.
+
+## Swagger documentation settings example:
+
+```
+const settings = {
+    info: {
+        "version": "1.0.0",
+        "title": "Title Example",
+        "description": "Description API example",
+        "termsOfService": "http://swagger.io/terms/",
+        "contact": {
+            "name": "Example team"
+        },
+        "license": {
+            "name": "MIT"
+        }
+    },
+    host: 'localhost:3000',
+    basePath: '/'
+}
+```
+
+Doc(app, settings);

src/Doc.ts

@@ -7,5 +7,7 @@
 
-export function Doc(app: any, info?: any) {
-    Swagger.swaggerDoc.createJsonDoc(info);
+export function Doc(app: any, settings?: any) {
+    const {info, host, basePath} = settings;
 
+    Swagger.swaggerDoc.createJsonDoc(info, host, basePath);
+
     app._router.stack.forEach((middleware: any) => {
@@ -12,0 +14,0 @@ if (middleware.route) { // routes registered directly on the app

src/example/index.ts

@@ -6,2 +6,3 @@ import * as express from 'express';
 import { Doc, Validate, RequestHandler } from '../index';
+import { settings } from './settings';
 
@@ -30,3 +31,3 @@ const app = express();
 app.listen(3000, () => {
-    Doc(app);
+    Doc(app, settings);
 })

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

17835

increased by5.61%

Number of package files

26

increased by4%

Lines of code

269

increased by6.75%

Number of lines in readme file

68

increased by54.55%

No dependency changes