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 hashes)