Skip to main content

Adds ApiDoc support to Tornado

Project description

# Tornado ApiDoc

Tornado ApiDoc is a simple apidoc serving plugin for tornado inspired by flask-apidoc.

## Installation

```
$ pip install tornado-apidoc
```

## Usage

```python
import tornado.web
from tornado_apidoc import make_apidoc_route

application = tornado.web.Application([
make_apidoc_route(folder_path='./static',
url_path='/docs')
])
```

## Example

```
$ git clone https://github.com/wenhan-wu/tornado-apidoc
$ cd tornado-apidoc
$ apidoc -i . -o ./static -f .py
$ python example.py
```

open [http://localhost:5000/docs](http://localhost:5000/docs) in your browser.

Project details


Release history Release notifications

This version

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tornado-apidoc, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size tornado-apidoc-1.0.0.tar.gz (2.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page