Added more customisation for Fastify skipList

README.md

@@ -64,8 +64,14 @@ This middleware function validates the request body, headers, path parameters an
 
 #### fastifyOptions
 
-- `skiplist`: Endpoint paths for which validation should not be applied. An array of strings in RegExp format, e. g. `['^/pets$']` 
-
+- `skiplist`: Endpoint paths with methods for which validation should not be applied. An object with array of strings in RegExp format for every method you want to specify, e. g.:
+    ```js
+    skipList: {
+        get: ['^/pets$', '^/ui$'],
+        post: ['^/cat$'],
+        delete: ['^/cat$']
+    }
+    ``` 
 ### openapi-validator-middleware.init(pathToSwaggerFile, options)
 
 Initialize the middleware using a swagger definition.

src/frameworks/fastify.js

@@ -9,11 +9,19 @@ function getValidator(validateRequest) {
     } catch (err) {
         throw new Error('Missing `uri-js` dependency. Please run "npm install uri-js" to use fastify plugin');
     }
-    let skiplist = [];
+    const skiplist = {
+        get: [],
+        post: [],
+        put: [],
+        delete: [],
+        patch: []
+    };
 
     return (pluginOptions) => {
         if (pluginOptions && pluginOptions.skiplist) {
-            skiplist = pluginOptions.skiplist.map((regexStr) => new RegExp(regexStr));
+            for (const key in pluginOptions.skiplist) {
+                skiplist[key] = pluginOptions.skiplist[key].map((regexStr) => new RegExp(regexStr));
+            }
         }
 
         return fp(function (fastify, options, next) {
@@ -24,7 +32,7 @@ function getValidator(validateRequest) {
 
     function validate(request, reply) {
         const requestOptions = _getParameters(request);
-        if (skiplist.some((skipListRegex) => {
+        if (skiplist[requestOptions.method.toLowerCase()].some((skipListRegex) => {
             return skipListRegex.test(requestOptions.path);
         })) {
             return Promise.resolve();

test/fastify/fastify-test-skiplist.js

@@ -17,7 +17,9 @@ describe('fastify plugin skiplist', () => {
         app = fastify({ logger: true });
 
         app.register(inputValidation.validate({
-            skiplist: ['^/pets$']
+            skiplist: {
+                get: ['^/pets$']
+            }
         }));
         app.setErrorHandler(async (err, req, reply) => {
             if (err instanceof inputValidation.InputValidationError) {
@@ -31,6 +33,9 @@ describe('fastify plugin skiplist', () => {
         app.get('/pets', (req, reply) => {
             reply.status(204).send();
         });
+        app.post('/pets', (req, reply) => {
+            reply.status(201).send();
+        });
 
         await app.ready();
     });
@@ -52,6 +57,21 @@ describe('fastify plugin skiplist', () => {
         expect(response.body).to.eql('');
     });
 
+    it('POST fails if only GET validation is ignored', async () => {
+        const response = await app.inject()
+            .headers({
+                'api-version': '1.0'
+            })
+            .body({
+                age: true
+            })
+            .post('/pets');
+        expect(response.statusCode).to.equal(400);
+        expect(response.json()).to.eql({
+            more_info: "[{\"keyword\":\"required\",\"dataPath\":\"\",\"schemaPath\":\"#/required\",\"params\":{\"missingProperty\":\"name\"},\"message\":\"should have required property 'name'\"},{\"keyword\":\"type\",\"dataPath\":\".age\",\"schemaPath\":\"#/properties/age/type\",\"params\":{\"type\":\"integer\"},\"message\":\"should be integer\"},{\"keyword\":\"required\",\"dataPath\":\"\",\"schemaPath\":\"#/required\",\"params\":{\"missingProperty\":\"test\"},\"message\":\"should have required property 'test'\"}]"
+        });
+    });
+
     it('Skips endpoint validation for request with multiple errors', async () => {
         const response = await app.inject().get('/pets');
         expect(response.statusCode).to.equal(204);

types/index.d.ts

@@ -53,7 +53,13 @@ export interface format {
 }
 
 export interface FastifyPluginOptions {
-    skiplist?: Array<string>;
+    skiplist?: {
+        get?: Array<string>,
+        post?: Array<string>
+        put?: Array<string>,
+        delete?: Array<string>,
+        patch?: Array<string>,
+    };
 }
 
 export interface ajvValidatorOptions {