https://github.com/diptangsu/sanic-swagger-ui

Inspired by flask-swagger-ui (https://github.com/sveint/flask-swagger-ui).
https://github.com/diptangsu/sanic-swagger-ui

documentation documentation-generator documentation-tool sanic sanic-framework swagger swagger-ui

Last synced: about 21 hours ago
JSON representation

Inspired by flask-swagger-ui (https://github.com/sveint/flask-swagger-ui).

• Host: GitHub
• URL: https://github.com/diptangsu/sanic-swagger-ui
• Owner: diptangsu
• Created: 2020-09-28T18:17:15.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-04T16:44:49.000Z (about 4 years ago)
• Last Synced: 2024-10-11T09:18:51.118Z (27 days ago)
• Topics: documentation, documentation-generator, documentation-tool, sanic, sanic-framework, swagger, swagger-ui
• Language: Python
• Homepage:
• Size: 3.06 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Sanic Swagger UI

Simple Sanic blueprint for adding [Swagger UI](https://github.com/swagger-api/swagger-ui) to your sanic application.

Inspired by [flask-swagger-ui](https://github.com/sveint/flask-swagger-ui).

## Installation

You can install it using `pip`.

```shell

pip install sanic_swagger_ui

```

## Usage

```python

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'

        '
'

        'Click here to view swagger docs'),

        status=200

    )

if __name__ == '__main__':

    app.run(debug=True)

```

You can find this example in [examples](/examples) directory in this repository.

Please add an issue if you want something added here or if you find a bug.