OpenAPI schema validation for Python
Project description
About
Openapi-schema-validator is a Python library that validates schema against the OpenAPI Schema Specification v3.0 which is an extended subset of the JSON Schema Specification Wright Draft 00.
Installation
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/p1c2u/openapi-schema-validator.git#egg=openapi_schema_validator
Usage
Simple usage
from openapi_schema_validator import validate
# A sample schema
schema = {
"type" : "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "integer",
"format": "int32",
"minimum": 0,
"nullable": True,
},
"birth-date": {
"type": "string",
"format": "date",
}
},
"additionalProperties": False,
}
# If no exception is raised by validate(), the instance is valid.
validate({"name": "John", "age": 23}, schema)
validate({"name": "John", "city": "London"}, schema)
Traceback (most recent call last):
...
ValidationError: Additional properties are not allowed ('city' was unexpected)
You can also check format for primitive types
from openapi_schema_validator import oas30_format_checker
validate({"name": "John", "birth-date": "-12"}, schema, format_checker=oas30_format_checker)
Traceback (most recent call last):
...
ValidationError: '-12' is not a 'date'
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for openapi-schema-validator-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5c9a1d2642f06d0fd8113c1cc804a91488467c3e3cf904691a047095fb9d781 |
|
MD5 | d1beda6eb973a2c1954d441b98ac628e |
|
BLAKE2b-256 | db03b4f6a87a1412dd9a5277b5ed1ec19d7dfc09c4a56112ba13a18765662349 |
Close
Hashes for openapi_schema_validator-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0625046e1c318605729bb4ede5d0fbbdf0297a41da4a3d21851d3d710b51d8a8 |
|
MD5 | bfd259ffef5a3f4a645985b3069813a4 |
|
BLAKE2b-256 | 0def8828660f1acd347d581763bc314febea50d813a07c70ada771d393e0e5b4 |