Swagger UI blueprint for Sanic
Project description
Sanic Swagger UI
Simple Flask blueprint for adding Swagger UI to your flask application.
Inspired by flask-swagger-ui.
Installation
You can install it using pip
.
pip install sanic_swagger_ui
Usage
from sanic import Sanic
from sanic import response
from sanic_swagger_ui import get_swaggerui_blueprint
app = Sanic(__name__)
STATIC_URL = '/static'
app.static(STATIC_URL, './static') # set static dir path
SWAGGER_URL = '/swagger'
DOCS_PATH = STATIC_URL + '/swagger/index.yaml' # serves files from the static dir
swaggerui_blueprint = get_swaggerui_blueprint(
DOCS_PATH,
SWAGGER_URL,
app_name='Swagger BP Test'
)
app.blueprint(swaggerui_blueprint)
@app.route('/')
async def index(req):
return response.html((
'Hello World from Sanic'
'<br>'
'Click <a href="/swagger/docs">here</a> to view swagger docs'),
status=200
)
if __name__ == '__main__':
app.run(debug=True)
You can find this example in examples directory in this repository.
Please add an issue if you want something added here or if you find a bug.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sanic-swagger-ui-0.0.1.tar.gz
(1.0 MB
view hashes)
Built Distribution
Close
Hashes for sanic_swagger_ui-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4309ab0c57cfed94283156106831670f15526368ea42f9542cee1683b1c5eac3 |
|
MD5 | 0864187f6363b5cd09e0109d7bb28f48 |
|
BLAKE2b-256 | f2fa62162222dabf36c3868658dfb3eda981204b4d0f267c3b84ce69fd4a756f |