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.
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 | 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
tornado-apidoc-1.0.0.tar.gz
(2.2 kB
view details)
File details
Details for the file tornado-apidoc-1.0.0.tar.gz.
File metadata
- Download URL: tornado-apidoc-1.0.0.tar.gz
- Upload date:
- Size: 2.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.13.0 setuptools/36.5.0.post20170921 requests-toolbelt/0.8.0 tqdm/4.15.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0d6d4e02182654d9102c0fae32fc1c811c1c65c6ecb4e9597e46ab21ce028fa3
|
|
| MD5 |
bc9886d664398d8abac7654ae0f238bb
|
|
| BLAKE2b-256 |
113c5a352b2267646c6356dfcd9dc8d42b3fe43e1db100a21731605bc39ee084
|