apispec-webframeworks

What it is and what it does

apispec-webframeworks provides plugins that bridge web frameworks and apispec, a library for building OpenAPI specifications programmatically. Instead of writing OpenAPI YAML by hand, you annotate your route handlers with docstrings and let the plugins extract parameter schemas, request/response types, and route metadata automatically. The package was split out from apispec's core and now maintains separate plugins for Flask, aiohttp, Bottle, and Tornado.

You install it alongside apispec and your chosen framework, then register the appropriate plugin when creating your APISpec instance. The plugins inspect your application's routes and docstrings to populate the specification, reducing duplication between your code and documentation. It requires Python 3.8 or later and has no heavy system dependencies.

Use it for:

• Generate OpenAPI specs for Flask REST APIs without manually writing YAML or JSON definitions
• Automatically document Tornado or aiohttp async endpoints with request/response schemas
• Migrate from older apispec versions by updating imports to use this separate package
• Keep API documentation in sync with code by deriving specs from route handlers
• Integrate OpenAPI specs into Swagger UI or ReDoc for interactive API browsing

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides web framework plugins for apispec to automatically generate OpenAPI specifications from Flask, aiohttp, Bottle, and Tornado applications.

Yes, if you use Flask, aiohttp, Bottle, or Tornado and want to generate OpenAPI specs from your code. It has low install friction, active maintenance, no known vulnerabilities, permissive licensing, and solves a real problem—keeping API documentation synchronized with implementation.

Install

apispec-webframeworks on PyPI

pip install apispec-webframeworks

uv add apispec-webframeworks

poetry add apispec-webframeworks

Installing apispec-webframeworks

Before you install

Low friction: single lightweight dependency on apispec, pure Python wheel, actively maintained with recent commits.

License in practice

MIT licensed under permissive terms, allowing commercial and private use with minimal restrictions.

Quickstart

pip install apispec-webframeworks

from apispec_webframeworks.flask import FlaskPlugin
from apispec import APISpec

spec = APISpec(
    title="API",
    version="1.0.0",
    plugins=[FlaskPlugin()],
)

Requires Python 3.8 or later; requires apispec to be installed separately.

Verify before relying

• Whether all four framework plugins (aiohttp, bottle, flask, tornado) are production-ready or have known limitations
• Performance impact when generating specs for large applications with many routes

Package facts

Evidence: apispec_webframeworks-1.2.0-py3-none-any.whl

Tags

More Application Frameworks packages