Skip to main content

Web framework plugins for apispec.

Project description

PyPI package Build status marshmallow 3 compatible

apispec plugins for integrating with various web frameworks.

These plugins used to be in apispec.ext but have since been moved to their own package.

Included plugins:

  • apispec_webframeworks.aiohttp

  • apispec_webframeworks.bottle

  • apispec_webframeworks.flask

  • apispec_webframeworks.tornado

Migration from apispec<1.0.0

To migrate from older versions of apispec, install this package with

pip install apispec-webframeworks

Change your imports, like so:

# apispec<1.0.0
from apispec.ext.flask import FlaskPlugin

# apispec>=1.0.0
from apispec_webframeworks.flask import FlaskPlugin

Example Usage

from flask import Flask
from apispec import APISpec
from apispec.ext.marshmallow import MarshmallowPlugin
from apispec_webframeworks.flask import FlaskPlugin
from marshmallow import Schema, fields

spec = APISpec(
    title="Gisty",
    version="1.0.0",
    info=dict(description="A minimal gist API"),
    plugins=[FlaskPlugin(), MarshmallowPlugin()],
)


app = Flask(__name__)


class GistParameter(Schema):
    gist_id = fields.Int()


class GistSchema(Schema):
    id = fields.Int()
    content = fields.Str()


@app.route("/gists/<gist_id>")
def gist_detail(gist_id):
    """Gist detail view.
    ---
    get:
        parameters:
                - in: path
                schema: GistParameter
        responses:
                200:
                schema: GistSchema
    """
    return "details about gist {}".format(gist_id)


# Since `path` inspects the view and its route,
# we need to be in a Flask request context
with app.test_request_context():
    spec.path(view=gist_detail)

Documentation

For documentation for a specific plugin, see its module docstring.

Development

  • Clone and cd into this repo

  • Create and activate a virtual environment

  • Install this package (in editable mode) and the development dependencies

$ pip install '.[dev]'
  • Install pre-commit hooks

$ pre-commit install

Running tests

To run all tests:

$ pytest

To run syntax checks:

$ tox -e lint

(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed):

$ tox

License

MIT licensed. See the bundled LICENSE file for more details.

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

apispec_webframeworks-1.2.0.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

apispec_webframeworks-1.2.0-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file apispec_webframeworks-1.2.0.tar.gz.

File metadata

  • Download URL: apispec_webframeworks-1.2.0.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for apispec_webframeworks-1.2.0.tar.gz
Algorithm Hash digest
SHA256 5689288c266a2713c2f516eacc14ea2fec9b21f193edc8f659c770342b97fd81
MD5 75e31c1ac9d06ffa78246926b3d95edf
BLAKE2b-256 f91f8d98328269a2507b6cfe37e8a70725d168626615865dc7aec30e8720c495

See more details on using hashes here.

File details

Details for the file apispec_webframeworks-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for apispec_webframeworks-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68aea0d1eeb3caeeacc7d6772a48c59c8b60b1a88d0bd51529d94597ccf33116
MD5 c9ea23bfa781cfa17ae1bd5da256f082
BLAKE2b-256 712c5aa396a3bca60de3b3f419ea770b8087d52aac5221bf15ddcd9b48d61d3c

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