Skip to main content

An inventory tool for Django Rest Framework v2 API endpoints.

Project description

===========================
Rest Framework Docs (0.1.1)
===========================

Rest Framework Docs is an application built to produce an inventory
and documentation for your Django Rest Framework v2 endpoints.

![Screenshot](https://raw.github.com/marcgibbons/django-rest-framework-docs/v0.1.1/screenshots/api-docs.png)

Installation
------------
From pip:

pip install django-rest-framework-docs

From the source:
- Download the tarball: <a href="dist/django-rest-framework-docs-0.1.1.tar.gz">django-rest-framework-docs-0.1.1.tar.gz</a>
- Extract files
- Run python setup.py install

Quick start
-----------

1. Add "rest_framework_docs" to your INSTALLED_APPS setting like this:

INSTALLED_APPS = (
...
'rest_framework_docs',
)

2. Include the polls URLconf in your project urls.py like this:

url(r'^rest-api/', include('rest_framework_docs.urls')),


3. View /rest-api/ to see your Django Rest Framework endpoints


How it works
------------

The Django Rest Framework Docs scans your projects URL patterns for endpoints
inheriting from Django Rest Framework views. It extracts comments, variables
and methods from your code to generate documentation.
Here is what is being tracked to generate documentation:

1) The name attribute from the URL pattern is used as the title. The following will produce a title of 'List of Countries'

url(r'^api/countries/?$', views.Countries.as_view(), name='list_of_countries'),


2) The class doctsring is used as the description::

class Countries(APIView):
"""
This text is the description for this API
"""

3) The class model. (ie. User)

4) Allowed methods (GET, POST, PUT, etc.)

5) Serializer properties. If your API uses a serializer, the properties are
listed

5) Custom parameters. It is possible to customize a parameter list for your
API. To do so, include a key-value pair in the docstring of your API class
delimited by two hyphens ('--').

Example: 'start_time -- The first reading'::

class Countries(APIView):
"""
This text is the description for this API
param1 -- A first parameter
param2 -- A second parameter
"""

Included Example
-----------------
Included is an example project called <a href="cigar_example/">cigar_example</a>. It contains both Model-based
and custom API views to demonstrate the different behaviours. I also included an API of the documentation,
that is, the data parsed by the generator in JSON format (api/docs). Yes, it's an API about APIs.

![ApiInception](https://raw.github.com/marcgibbons/django-rest-framework-docs/v0.1.1/screenshots/docs-in-api-form.png)

Special Thanks
--------------
Many thanks to Tom Christie for developing the Django Rest Framework - a tool I use everyday.

Release Notes
-------------
### v0.1.1 (Jan 24, 2013)
- Fixed trailing $ sign in the URL pattern regex
- Changed URL pattern to show docs at index
- Added example Django REST application called cigar_example.
- Minor CSS changes
- Fixed setup.py requirements to require django>=1.4

License
--------
Copyright (c) 2013, Marc Gibbons
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Project details


Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page