Skip to main content

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-tastypie-simple-api-doc, version 0.0.1b2
Filename, size File type Python version Upload date Hashes
Filename, size django-tastypie-simple-api-doc-0.0.1b2.tar.gz (996.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page