Add validateApiDoc props in OpenApiValidatorOpts (#525)

* Add validateApiDoc props in OpenApiValidatorOpts * rename validateApiSpec to validateApiDoc Co-authored-by: Carmine DiMascio <[email protected]>
cdimascio · Feb 3, 2021 · cfb9fb7 · cfb9fb7
1 parent d09f1a2
commit cfb9fb7
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -478,6 +478,7 @@ OpenApiValidator.middleware({
   apiSpec: './openapi.yaml',
   validateRequests: true,
   validateResponses: true,
+  validateApiSpec: true,
   validateSecurity: {
     handlers: {
       ApiKeyAuth: (req, scopes, schema) => {
@@ -647,6 +648,14 @@ Determines whether the validator should validate securities e.g. apikey, basic,
   }
   ```
 
+### ▪️ validateApiSpec (optional)
+
+Determines whether the validator should validate the OpenAPI specification. Useful if you are certain that the api spec is syntactically correct and want to bypass this check.
+
+- `true` (**default**) - validate the OpenAPI specification.
+- `false` - do not validate the OpenAPI specification.
+
+
 ### ▪️ formats (optional)
 
 Defines a list of custome formats.

diff --git a/src/framework/index.ts b/src/framework/index.ts
@@ -31,14 +31,14 @@ export class OpenAPIFramework {
         return acc;
       }, new Set<string>()),
     );
-    const validateApiDoc =
-      'validateApiDoc' in args ? !!args.validateApiDoc : true;
+    const validateApiSpec =
+      'validateApiSpec' in args ? !!args.validateApiSpec : true;
     const validator = new OpenAPISchemaValidator({
       version: apiDoc.openapi,
       // extensions: this.apiDoc[`x-${args.name}-schema-extension`],
     });
 
-    if (validateApiDoc) {
+    if (validateApiSpec) {
       const apiDocValidation = validator.validate(apiDoc);
 
       if (apiDocValidation.errors.length) {

diff --git a/src/framework/types.ts b/src/framework/types.ts
@@ -76,6 +76,7 @@ export type Serializer = {
 
 export interface OpenApiValidatorOpts {
   apiSpec: OpenAPIV3.Document | string;
+  validateApiSpec?: boolean;
   validateResponses?: boolean | ValidateResponseOpts;
   validateRequests?: boolean | ValidateRequestOpts;
   validateSecurity?: boolean | ValidateSecurityOpts;
@@ -412,7 +413,7 @@ export interface OpenAPIFrameworkPathObject {
 
 interface OpenAPIFrameworkArgs {
   apiDoc: OpenAPIV3.Document | string;
-  validateApiDoc?: boolean;
+  validateApiSpec?: boolean;
   $refParser?: {
     mode: 'bundle' | 'dereference';
   };

diff --git a/src/index.ts b/src/index.ts
@@ -35,6 +35,7 @@ function openapiValidator(options: OpenApiValidatorOpts) {
   return oav.installMiddleware(
     new OpenApiSpecLoader({
       apiDoc: options.apiSpec,
+      validateApiSpec: options.validateApiSpec,
       $refParser: options.$refParser,
     }).load(),
   );