Skip to main content

Easily document your Sanic API with a UI.

Project description

Sanic OpenAPI

Build Status PyPI PyPI Code style: black codecov

Give your Sanic API a UI and OpenAPI documentation, all for the price of free!

Example Swagger UI


pip install sanic-openapi

Add Swagger UI with the OpenAPI spec:

from sanic_openapi import swagger_blueprint


You'll now have a Swagger UI at the URL /swagger/ and an OpenAPI 2.0 spec at /swagger/swagger.json. Your routes will be automatically categorized by their blueprints.


Here is an example to use Sanic-OpenAPI:

from sanic import Sanic
from sanic.response import json
from sanic_openapi import swagger_blueprint

app = Sanic()

async def test(request):
    return json({"hello": "world"})

if __name__ == "__main__":"", port=8000)

And you can get your Swagger document at http://localhost:8000/swagger like this:


Please check the documentation on Readthedocs


Any contribution is welcome. If you don't know how to getting started, please check issues first and check our Contributing Guide to start you contribution.

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

sanic-openapi-0.6.2.tar.gz (2.3 MB view hashes)

Uploaded Source

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