Installation

pip install django-tastypie-simple-api-doc

Usage

First, add this to installed app and django_markup (we use this package to format classes docstrings).

INSTALLED_APPS = (
        'tastypie_api_doc',
        'django_markup',
)

Then 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 my test project 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. :)

This is a work in progress but it can be already used in your projects. So, stay tuned. Feel free to contribute to get this app way more better. =D

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for django-tastypie-simple-api-doc 0.5.0b1
File	Size	Uploaded
django-tastypie-simple-api-doc-0.5.0b1.tar.gz	1.2 MB	Mar 9, 2016	Details

Download URL	django-tastypie-simple-api-doc-0.5.0b1.tar.gz
Size	1.2 MB
Tags	Source
SHA-256 checksum How to use checksums	`6a1df09f256a2ad4624a2564c4f1d8552b624722175dd19586391da47e72050b`
BLAKE2b-256 checksum How to use checksums	`1cd0ef486e4e8419011bbf387c0e2c044e0091ad03055a22f0fb35311b2f3b1f`
Upload date	Mar 9, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No