By default, OpenAPI spec version is detected. To validate spec:
from openapi_spec_validator import validate
from openapi_spec_validator.readers import read_from_filename
spec_dict, base_uri = read_from_filename('openapi.yaml')
# If no exception is raised by validate(), the spec is valid.
validate(spec_dict)
validate({'openapi': '3.1.0'})
Traceback (most recent call last):
...
OpenAPIValidationError: 'info' is a required property
Add base_uri to validate spec with relative files:
validate(spec_dict, base_uri='file:///path/to/spec/openapi.yaml')
You can also validate spec from url:
from openapi_spec_validator import validate_url
# If no exception is raised by validate_url(), the spec is valid.
validate_url('http://example.com/openapi.json')
In order to explicitly validate a:
Swagger / OpenAPI 2.0 spec, import OpenAPIV2SpecValidator
OpenAPI 3.0 spec, import OpenAPIV30SpecValidator
OpenAPI 3.1 spec, import OpenAPIV31SpecValidator
and pass the validator class to validate or validate_url function:
validate(spec_dict, cls=OpenAPIV31SpecValidator)
You can also explicitly import OpenAPIV3SpecValidator which is a shortcut to the latest v3 release.
If you want to iterate through validation errors:
from openapi_spec_validator import OpenAPIV31SpecValidator
errors_iterator = OpenAPIV31SpecValidator(spec).iter_errors()
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4