validate shortcut

Author: p1c2u

README.rst

@@ -43,7 +43,7 @@ Simple usage
 
 .. code-block:: python
 
-   from openapi_schema_validator import OAS30Validator, oas30_format_checker
+   from openapi_schema_validator import validate
 
    # A sample schema
    schema = {
@@ -61,20 +61,37 @@ Simple usage
                "minimum": 0,
                "nullable": True,
            },
+           "birth-date": {
+               "type": "string",
+               "format": "date",
+           }
        },
        "additionalProperties": False,
    }
 
-   validator = OAS30Validator(schema)
    # If no exception is raised by validate(), the instance is valid.
-   validator.validate({"name": "John", "age": 23})
+   validate({"name": "John", "age": 23}, schema)
 
-   validator.validate({"name": "John", "city": "London"})
+   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
+
+.. code-block:: python
+
+   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'
+
+
 Related projects
 ################
 * `openapi-core <https://github.com/p1c2u/openapi-core>`__

openapi_schema_validator/__init__.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from openapi_schema_validator._format import oas30_format_checker
+from openapi_schema_validator.shortcuts import validate
 from openapi_schema_validator.validators import OAS30Validator
 
 __author__ = 'Artur Maciag'
@@ -8,4 +9,4 @@
 __url__ = 'https://github.com/p1c2u/openapi-schema-validator'
 __license__ = 'BSD 3-Clause License'
 
-__all__ = ['OAS30Validator', 'oas30_format_checker']
+__all__ = ['validate', 'OAS30Validator', 'oas30_format_checker']

openapi_schema_validator/shortcuts.py

@@ -0,0 +1,11 @@
+from jsonschema.exceptions import best_match
+
+from openapi_schema_validator.validators import OAS30Validator
+
+
+def validate(instance, schema, cls=OAS30Validator, *args, **kwargs):
+    cls.check_schema(schema)
+    validator = cls(schema, *args, **kwargs)
+    error = best_match(validator.iter_errors(instance))
+    if error is not None:
+        raise error