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:
API_OBJECT_LOCATION = "app.module.object_name"
In mais test projetc was like this:
API_OBJECT_LOCATION = "project.urls.v1_api"
Got it? Now go to your urls module and goes like this:
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.
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
Close
Hashes for django-tastypie-simple-api-doc-0.0.1b3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76149b2d1f44a4c3a7e32bf28f57a3dad713a78ae9ee5206caddc117f77f31d4 |
|
MD5 | 184af61cecbe4c0ebf89a4a54c6bb03c |
|
BLAKE2b-256 | a56f484b00b76bce0e9578e162900f102f2d33dbc046229e8876a195fbd25b48 |