openapi_core_request_validation_with_spec_validator.py

1from openapi_core import validate_request
2from openapi_core.testing import OpenAPIRequest
3from openapi_spec_validator import validate_spec
4from openapi_spec_validator.readers import read_from_filename
5
6# 1. Load the specification
7spec_dict, spec_url = read_from_filename('openapi.yaml')
8
9# 2. Validate the specification (optional but recommended)
10validate_spec(spec_dict)
11
12# 3. Create a request object to validate
13# In a real application, you would wrap your framework's request (e.g., Flask, Django)
14# using openapi-core's built-in framework integrations.
15request = OpenAPIRequest(
16    full_url_pattern='https://localhost/v1/pets',
17    method='get',
18    parameters={
19        'query': {
20            'page': '1',
21        },
22    },
23)
24
25# 4. Validate the request
26result = validate_request(request, spec=spec_dict)
27
28# 5. Check for errors
29if result.errors:
30    for error in result.errors:
31        print(f"Validation error: {error}")
32else:
33    print("Request is valid!")
34    # Access validated data
35    print(f"Validated query parameters: {result.parameters.query}")