OpenAPI/Swagger Validation: Prevent API Documentation Drift

[jwesleye]

Problem Statement

API documentation issues cause integration failures:

• OpenAPI spec drift from actual implementation
• Breaking changes not detected
• Invalid example responses
• Missing security definitions
• Inconsistent schemas across endpoints

Goal

Validate OpenAPI/Swagger specifications to ensure accuracy and prevent breaking changes.

Proposed Solution (~10 functions)

• validate_openapi_schema(), validate_swagger_schema(), validate_schema_references(), validate_example_responses()
• detect_api_breaking_changes(), detect_inconsistent_schemas()
• check_api_security_definitions(), validate_path_parameters(), check_response_status_codes()
• parse_api_operations()