Skip to main content

Framework for Quart to add swagger generation to routes and restful resources

Project description

https://travis-ci.com/factset/quart-openapi.svg?branch=master

Documentation can be found on https://factset.github.io/quart-openapi/

Quart-OpenAPI is an extension for Quart that adds support for generating a openapi.json file using openapi 3.0. If you are familiar with Quart, this just wraps around it to add a openapi.json route similar to Flask-RESTX generating a swagger.json route and adds a Resource base class for building RESTful APIs.

Compatibility

Quart-OpenAPI requires Python 3.6+ because Quart requires it.

Starting from version 1.6.0, Quart-OpenAPI requires python 3.7+ in order to avoid having to maintain multiple versions of function definitions for compatibility with the older versions of Quart that supported Python 3.6.

Installation

You can install via pip

$ pip install quart-openapi

If you are developing the module and want to also be able to build the documentation, make sure to also install the dependencies from the extras ‘doc’ package like so:

$ pip install 'quart-openapi[doc]'
$ python setup.py build_sphinx

Quick Start

If you’re familiar with Quart then the quick start doesn’t change much:

from quart_openapi import Pint, Resource

app = Pint(__name__, title='Sample App')

@app.route('/')
class Root(Resource):
  async def get(self):
    '''Hello World Route

    This docstring will show up as the description and short-description
    for the openapi docs for this route.
    '''
    return "hello"

This is equivalent to using the following with Quart as normal:

from quart import Quart
app = Quart(__name__)

@app.route('/')
async def hello():
  return "hello"

Except that by using Pint and Resource it will also add a route for ‘/openapi.json’ which will contain the documentation of the route and use the docstring for the description.

Unit Tests

Unit tests can be run through setuptools also:

$ python setup.py test

Request Validation

Request validation like you can get with Flask-RESTX!

You can either create validator models on the fly or you can create a jsonschema document for base models and then use references to it. For an on-the-fly validator:

expected = app.create_validator('sample_request', {
  'type': 'object',
  'properties': {
    'foobar': {
      'type': 'string'
    },
    'baz': {
      'oneOf': [
        { 'type': 'integer' },
        { 'type': 'number', 'format': 'float' }
      ]
    }
  }
})

@app.route('/')
class Sample(Resource):
  @app.expect(expected)
  async def post(self):
    # won't get here if the request didn't match the expected schema
    data = await request.get_json()
    return jsonify(data)

The default content type is ‘application/json’, but you can specify otherwise in the decorator:

{
  "$schema": "http://json-schema.org/schema#",
  "id": "schema.json",
  "components": {
    "schemas": {
      "binaryData": {
        "type": "string",
        "format": "binary"
      }
    }
  }
}
app = Pint(__name__, title='Validation Example',
              base_model_schema='schema.json')
stream = app.create_ref_validator('binaryData', 'schemas')

@app.route('/')
class Binary(Resource):
  @app.expect((stream, 'application/octet-stream',
               {'description': 'gzip compressed data'}))
  @app.response(HTTPStatus.OK, 'Success')
  async def post(self):
    # if the request didn't have a 'content-type' header with a value
    # of 'application/octet-stream' it will be rejected as invalid.
    raw_data = await request.get_data(raw=True)
    # ... do something with the data
    return "Success!"

In the example above, it’ll open, read, and json parse the file schema.json and then use it as the basis for referencing models and creating validators. Currently the validator won’t do more than validate content-type for content-types other than ‘application/json’.

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-openapi-1.7.2.tar.gz (21.8 kB view details)

Uploaded Source

Built Distributions

quart_openapi-1.7.2-py3.7.egg (49.1 kB view details)

Uploaded Source

quart_openapi-1.7.2-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file quart-openapi-1.7.2.tar.gz.

File metadata

  • Download URL: quart-openapi-1.7.2.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.6

File hashes

Hashes for quart-openapi-1.7.2.tar.gz
Algorithm Hash digest
SHA256 f57f6db77776a0f6b6d5ff37d8b7a0039abdd2a15988eb1c32cc402093bf8628
MD5 146fb35f232c08ca10c8fbc884a8241b
BLAKE2b-256 3c48973b0dbddaf4cde9a4207340e8e3f2536ecbc513fc4439a2819f69a859ad

See more details on using hashes here.

File details

Details for the file quart_openapi-1.7.2-py3.7.egg.

File metadata

  • Download URL: quart_openapi-1.7.2-py3.7.egg
  • Upload date:
  • Size: 49.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.6

File hashes

Hashes for quart_openapi-1.7.2-py3.7.egg
Algorithm Hash digest
SHA256 e4c1b87a83e656d9dc27d910255d03c0985c63c814f924d107745de1940fc65d
MD5 012eb712d3dc795080fbb1d4704a1bcf
BLAKE2b-256 17e24ee49a3bbc69d061fab15a5991d09991b97412ffb8f8f7a753add472d43e

See more details on using hashes here.

File details

Details for the file quart_openapi-1.7.2-py3-none-any.whl.

File metadata

  • Download URL: quart_openapi-1.7.2-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.6

File hashes

Hashes for quart_openapi-1.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a65b1d331e7b59400b79a1cbb4890bbf57bbfd1b63e13f78c38b4b31d1476021
MD5 61d1d68fd047325ef8caf797d9eab6d2
BLAKE2b-256 a9ff19e6d3bae77a7daf52ddd1494a87c6b38004e856082c5fa5e223305b6830

See more details on using hashes here.

Supported by

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