Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

JSON request validation with jsonschema for Flask applications

License

Notifications You must be signed in to change notification settings

pallets-eco/flask-jsonschema

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flask-JsonSchema

JSON request validation for Flask applications.

Place schemas in the specified JSONSCHEMA_DIR.

import os

from flask import Flask, request
from flask_jsonschema import JsonSchema, ValidationError

app = Flask(__name__)
app.config['JSONSCHEMA_DIR'] = os.path.join(app.root_path, 'schemas')

jsonschema = JsonSchema(app)

@app.errorhandler(ValidationError)
def on_validation_error(e):
    return "error"

@app.route('/books', methods=['POST'])
@jsonschema.validate('books', 'create')
def create_book():
    # create the book
    return 'success'

The schema for the example above should be named books.json and should reside in the configured folder. It should look like so:

{
  "create": {
    "type": "object",
    "properties": {
      "title": {},
      "author": {}
    },
    "required": ["title", "author"]
  },
  "update": {
    "type": "object",
    "properties": {
      "title": {},
      "author": {}
    }
  }
}

Notice the top level action names. Flask-JsonSchema supports one "path" level so that you can organize related schemas in one file. If you do not wish to use this feature you can simply use one schema per file and remove the second parameter to the @jsonschema.validate call.

Resources

About

JSON request validation with jsonschema for Flask applications

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages