Skip to main content

A Quart extension to provide schema validation

Project description

Build Status docs pypi python license

Quart-Schema is a Quart extension that provides schema validation and auto-generated API documentation. This is particularly useful when writing RESTful APIs.

Quart-Schema can use either msgspec or pydantic to validate.

Quickstart

Quart-Schema can validate an existing Quart route by decorating it with validate_querystring, validate_request, or validate_response. It can also validate the JSON data sent and received over websockets using the send_as and receive_as methods.

from dataclasses import dataclass
from datetime import datetime

from quart import Quart, websocket
from quart_schema import QuartSchema, validate_request, validate_response

app = Quart(__name__)
QuartSchema(app)

@dataclass
class Todo:
    task: str
    due: datetime | None

@app.post("/")
@validate_request(Todo)
@validate_response(Todo, 201)
async def create_todo(data: Todo) -> tuple[Todo, int]:
    ... # Do something with data, e.g. save to the DB
    return data, 201

@app.websocket("/ws")
async def ws() -> None:
    while True:
        data = await websocket.receive_as(Todo)
        ... # Do something with data, e.g. save to the DB
        await websocket.send_as(data, Todo)

The documentation is served by default at /openapi.json according to the OpenAPI standard, or at /docs for a SwaggerUI interface, or /redocs for a redoc interface, or /scalar for a Scalar interface. Note that there is currently no documentation standard for WebSockets.

Contributing

Quart-Schema is developed on GitHub. If you come across an issue, or have a feature request please open an issue. If you want to contribute a fix or the feature-implementation please do (typo fixes welcome), by proposing a merge request.

Testing

The best way to test Quart-Schema is with Tox,

$ pip install tox
$ tox

this will check the code style and run the tests.

Help

The Quart-Schema documentation is the best places to start, after that try searching stack overflow or ask for help on gitter. If you still can’t find an answer please open an issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quart_schema-0.22.0.tar.gz (24.5 kB view details)

Uploaded Source

Built Distribution

quart_schema-0.22.0-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file quart_schema-0.22.0.tar.gz.

File metadata

  • Download URL: quart_schema-0.22.0.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for quart_schema-0.22.0.tar.gz
Algorithm Hash digest
SHA256 6ee190427d114b572f9f3f31b6babb5d85b3b0329cdc47c5346b569f3000084c
MD5 651de62f1363dba95130c8641c71c19a
BLAKE2b-256 ee1069cc4344e9f01a06aea92ccbc3352fefb02b53d976954bcc7f4e4e69ba36

See more details on using hashes here.

Provenance

The following attestation bundles were made for quart_schema-0.22.0.tar.gz:

Publisher: publish.yml on pgjones/quart-schema

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quart_schema-0.22.0-py3-none-any.whl.

File metadata

  • Download URL: quart_schema-0.22.0-py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for quart_schema-0.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a86e16beda0b0b6e15237baa8b8e690b90dea4b68b8b84147151cf5dd6cff78
MD5 b950992ea1740dcab8c8676238b36752
BLAKE2b-256 2a6e2c290b3877a1e3d20e901b8e26573b7db46704b0b173462d11e1709444ca

See more details on using hashes here.

Provenance

The following attestation bundles were made for quart_schema-0.22.0-py3-none-any.whl:

Publisher: publish.yml on pgjones/quart-schema

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page