Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork33
OpenAPI schema validator is a Python library that validates schema against OpenAPI Schema Specification v3.0 and v3.1
License
python-openapi/openapi-schema-validator
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Openapi-schema-validator is a Python library that validates schema against:
- OpenAPI Schema Specification v3.0 which is an extended subset of theJSON Schema Specification Wright Draft 00.
- OpenAPI Schema Specification v3.1 which is an extended superset of theJSON Schema Specification Draft 2020-12.
Check documentation to see more details about the features. All documentation is in the "docs" directory and online atopenapi-schema-validator.readthedocs.io
Recommended way (via pip):
pip install openapi-schema-validator
Alternatively you can download the code and install from the repository:
pip install -e git+https://github.com/python-openapi/openapi-schema-validator.git#egg=openapi_schema_validator
To validate an OpenAPI v3.1 schema:
fromopenapi_schema_validatorimportvalidate# A sample schemaschema= {"type":"object","required": ["name" ],"properties": {"name": {"type":"string" },"age": {"type": ["integer","null"],"format":"int32","minimum":0, },"birth-date": {"type":"string","format":"date", },"address": {"type":'array',"prefixItems": [ {"type":"number" }, {"type":"string" }, {"enum": ["Street","Avenue","Boulevard"] }, {"enum": ["NW","NE","SW","SE"] } ],"items":False, } },"additionalProperties":False,}# If no exception is raised by validate(), the instance is valid.validate({"name":"John","age":23,"address": [1600,"Pennsylvania","Avenue"]},schema)validate({"name":"John","city":"London"},schema)Traceback (mostrecentcalllast): ...ValidationError:Additionalpropertiesarenotallowed ('city'wasunexpected)
By default, the latest OpenAPI schema syntax is expected.
For more details read aboutValidation.
- openapi-core
- Python library that adds client-side and server-side support for the OpenAPI.
- openapi-spec-validator
- Python library that validates OpenAPI Specs against the OpenAPI 2.0 (aka Swagger) and OpenAPI 3.0 specification
About
OpenAPI schema validator is a Python library that validates schema against OpenAPI Schema Specification v3.0 and v3.1
Topics
Resources
License
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.
Packages0
Uh oh!
There was an error while loading.Please reload this page.