Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
setup_swagger
✓ from aiohttp_swagger import setup_swagger
✗ from aiohttp_swagger import swagger
Wrong symbol, older examples used 'swagger' but current uses setup_swagger
swagger
✓ from aiohttp_swagger import swagger
Valid alternative import for the swagger decorator
swagger_path
✓ from aiohttp_swagger import swagger_path
Commonly imported for YAML file path
Basic aiohttp app with Swagger UI enabled
from aiohttp import web
from aiohttp_swagger import setup_swagger
async def handler(request):
return web.json_response({"hello": "world"})
app = web.Application()
app.router.add_get('/hello', handler)
setup_swagger(app, swagger_url="/api/v1/doc")
web.run_app(app, host='0.0.0.0', port=8080)
Errors
Common errors & fixes
ImportError: cannot import name 'setup_swagger' from 'aiohttp_swagger'
Installed version < 1.0.0 or wrong import path
fixUpgrade to latest: pip install --upgrade aiohttp-swagger
TypeError: setup_swagger() got an unexpected keyword argument 'swagger_url'
Older version of library does not support swagger_url parameter
fixUse 'url' instead: setup_swagger(app, url='/api/v1/doc')
AttributeError: module 'aiohttp_swagger' has no attribute 'swagger'
Misunderstanding the import; 'swagger' is a decorator, not a function
fixUse: from aiohttp_swagger import swagger as swagger_decorator
Upgrade
Version history
1.0.16latest on PyPI · released Oct 22, 2021
Audit
Dependencies
aiohttprequiredRequires aiohttp server