Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 2x 2x 2x 2x 2x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 1x 4x 4x 2x 3x | class OpenApiValidator {
/**
* Validates OpenAPI specification
* @param {object} spec - OpenAPI specification
* @returns {Promise<object>} Validation result
*/
async validate(spec) {
const result = {
valid: true,
errors: [],
warnings: [],
info: {}
};
try {
// Check for OpenAPI or Swagger version
Iif (!spec.openapi && !spec.swagger) {
result.valid = false;
result.errors.push('Invalid OpenAPI format: missing openapi or swagger version field');
} else {
result.info.version = spec.openapi || spec.swagger;
}
// Validate info section
Iif (!spec.info) {
result.valid = false;
result.errors.push('Missing required "info" section in OpenAPI spec');
} else {
Iif (!spec.info.title) {
result.errors.push('Missing required "info.title" in OpenAPI spec');
}
Iif (!spec.info.version) {
result.errors.push('Missing required "info.version" in OpenAPI spec');
}
result.info.apiTitle = spec.info.title;
result.info.apiVersion = spec.info.version;
}
// Validate paths
Iif (!spec.paths || Object.keys(spec.paths).length === 0) {
result.valid = false;
result.errors.push('OpenAPI spec must define at least one path');
} else {
result.info.pathCount = Object.keys(spec.paths).length;
const pathValidation = this.validatePaths(spec.paths);
result.errors.push(...pathValidation.errors);
result.warnings.push(...pathValidation.warnings);
result.info.operations = pathValidation.operations;
}
// Check for servers/host
if (spec.openapi && !spec.servers) {
result.warnings.push('OpenAPI 3.0 spec should define servers');
} else Iif (spec.swagger && !spec.host) {
result.warnings.push('Swagger 2.0 spec should define host');
}
Iif (result.errors.length > 0) {
result.valid = false;
}
} catch (error) {
result.valid = false;
result.errors.push(`OpenAPI validation error: ${error.message}`);
}
return result;
}
/**
* Validate paths section
* @param {object} paths - Paths object from OpenAPI spec
* @returns {object} Validation result
*/
validatePaths(paths) {
const result = {
errors: [],
warnings: [],
operations: 0
};
const allowedMethods = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options'];
for (const [pathName, pathDef] of Object.entries(paths)) {
// Path must start with /
Iif (!pathName.startsWith('/')) {
result.errors.push(`Path "${pathName}" must start with /`);
}
// Check for valid HTTP methods
const methods = Object.keys(pathDef).filter(m =>
allowedMethods.includes(m.toLowerCase())
);
Iif (methods.length === 0) {
result.errors.push(`Path "${pathName}" has no valid HTTP methods`);
}
// Validate each operation
for (const method of methods) {
result.operations++;
const operation = pathDef[method];
// Check for responses
Iif (!operation.responses) {
result.errors.push(`Operation ${method.toUpperCase()} ${pathName} missing responses`);
} else Iif (Object.keys(operation.responses).length === 0) {
result.errors.push(`Operation ${method.toUpperCase()} ${pathName} has empty responses`);
}
// Check for summary or description
if (!operation.summary && !operation.description) {
result.warnings.push(`Operation ${method.toUpperCase()} ${pathName} should have summary or description`);
}
// Check for operationId
Eif (!operation.operationId) {
result.warnings.push(`Operation ${method.toUpperCase()} ${pathName} should have operationId`);
}
}
}
return result;
}
/**
* Check if spec is compatible with OpenAPI 3.0
* @param {object} spec - OpenAPI specification
* @returns {boolean} Compatibility check result
*/
isOpenApi3(spec) {
return spec.openapi && spec.openapi.startsWith('3.');
}
/**
* Check if spec is compatible with Swagger 2.0
* @param {object} spec - OpenAPI specification
* @returns {boolean} Compatibility check result
*/
isSwagger2(spec) {
return spec.swagger && spec.swagger === '2.0';
}
}
module.exports = OpenApiValidator; |