A Django app to generate a simple and automatic api documentation with Tastypie
Project description
A Django app to generate a simple and automatic api documentation with Tastypie.
Installation
============
```
pip install django-tastypie-simple-api-doc
```
Usage
============
First, you need to tell me where is your Tastypie Api object that will be documented. Put it's path in ```settings.py``` like this:
```python
API_OBJECT_LOCATION = "app.module.object_name"
```
In mais test projetc was like this:
```python
API_OBJECT_LOCATION = "project.urls.v1_api"
```
Got it? Now go to your urls module and goes like this:
```python
from tastypie_api_doc.views import build_doc
urlpatterns = [
...
url(r'^choose_your_url', build_doc),
]
```
And....We are almost there. Now, you need to "collect your static" if you know what I mean. :P
```
python manage.py collectstatic
```
And this is it. :)
For now, this django app just create a table with your Tastypie Endpoints. Feel free to contribute to get this app way more better.
Installation
============
```
pip install django-tastypie-simple-api-doc
```
Usage
============
First, you need to tell me where is your Tastypie Api object that will be documented. Put it's path in ```settings.py``` like this:
```python
API_OBJECT_LOCATION = "app.module.object_name"
```
In mais test projetc was like this:
```python
API_OBJECT_LOCATION = "project.urls.v1_api"
```
Got it? Now go to your urls module and goes like this:
```python
from tastypie_api_doc.views import build_doc
urlpatterns = [
...
url(r'^choose_your_url', build_doc),
]
```
And....We are almost there. Now, you need to "collect your static" if you know what I mean. :P
```
python manage.py collectstatic
```
And this is it. :)
For now, this django app just create a table with your Tastypie Endpoints. Feel free to contribute to get this app way more better.
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
Close
Hashes for django-tastypie-simple-api-doc-0.0.1b2.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9a8e84718c5e08fe8a51dec23f5beaf6393bdc38b589bcca03e7b2446e7efa17 |
|
| MD5 | 4c7d48ca7fb6a0c0114fc7cfa7a7ae3c |
|
| BLAKE2b-256 | 62f60814042b1432d8575b78e9677bb5e22787381af3014695b204edca62e813 |
