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
$ toxthis 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.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quart_schema-0.24.0.tar.gz.
File metadata
- Download URL: quart_schema-0.24.0.tar.gz
- Upload date:
- Size: 24.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
90c6dc2dd219a02a094e7c93083d97032b82a101145e5f6b15d29717f6fdbbb9
|
|
| MD5 |
d0a3a80c2bc4a00d869e65664e7ddcf8
|
|
| BLAKE2b-256 |
fa195875639b00b2a61ee0cd9334c3090082fa02069439aa379d153331123187
|
Provenance
The following attestation bundles were made for quart_schema-0.24.0.tar.gz:
Publisher:
publish.yml on pgjones/quart-schema
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quart_schema-0.24.0.tar.gz -
Subject digest:
90c6dc2dd219a02a094e7c93083d97032b82a101145e5f6b15d29717f6fdbbb9 - Sigstore transparency entry: 2340195185
- Sigstore integration time:
-
Permalink:
pgjones/quart-schema@ac10b892548f426a8de33d70087cb4ed43ce60b6 -
Branch / Tag:
refs/tags/0.24.0 - Owner: https://github.com/pgjones
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ac10b892548f426a8de33d70087cb4ed43ce60b6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file quart_schema-0.24.0-py3-none-any.whl.
File metadata
- Download URL: quart_schema-0.24.0-py3-none-any.whl
- Upload date:
- Size: 21.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5d781ff35168200498abbd3bb509560332f6b58d3b3bb2ab35abc897e082dfb5
|
|
| MD5 |
8c378cf810ade3d79e9d8d9b3a40c9a4
|
|
| BLAKE2b-256 |
9aa9f3201a1f094319ecd0263e19b03d88a7cf12eb4c3905261002d793326d7e
|
Provenance
The following attestation bundles were made for quart_schema-0.24.0-py3-none-any.whl:
Publisher:
publish.yml on pgjones/quart-schema
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quart_schema-0.24.0-py3-none-any.whl -
Subject digest:
5d781ff35168200498abbd3bb509560332f6b58d3b3bb2ab35abc897e082dfb5 - Sigstore transparency entry: 2340195356
- Sigstore integration time:
-
Permalink:
pgjones/quart-schema@ac10b892548f426a8de33d70087cb4ed43ce60b6 -
Branch / Tag:
refs/tags/0.24.0 - Owner: https://github.com/pgjones
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ac10b892548f426a8de33d70087cb4ed43ce60b6 -
Trigger Event:
push
-
Statement type:
