Repository files navigation

Document Web APIs made with Django Rest Framework.View Demo

• Python (2.7, 3.3, 3.4, 3.5)
• Django (1.8, 1.9)
• Django Rest Framework (3+)

• Installation
• Settings
• Extending the template
• Live API Endpoints
• Contributing & Development
• Changelog

If you are looking to develop this package with one of your own django projects:

pyvenv envenv/bin/pip install -r requirements.txtpip install -e ~/Projects/drf-docs/

If you want to use the demo app to work on this package:Included in this repo you can find the demo project(at/demo). It is a project withDjango &Django Rest Framework that will allow you to work with this project. For more information on how you can set it up please check theREADME.md of the demo project.

For more information visitthe docs.

Install using pip:

pip install drfdocs

Add 'rest_framework_docs' to yourINSTALLED_APPS setting:

INSTALLED_APPS = (    ...    'rest_framework_docs',)

Finally include therest_framework_docs urls in yoururls.py:

urlpatterns = [    ...    url(r'^docs/', include('rest_framework_docs.urls')),]

You can find detailed information about the package's settings atthe docs.

REST_FRAMEWORK_DOCS = {    'HIDE_DOCS': True  # Default: False}

First of all thanks to theDjango core team and to all the contributors ofDjango REST Framework for their amazing work. Also I would like to thankMarc Gibbons for hisdjango-rest-framework-docs project. Both projects share the same idea, it is just that Marc's is not maintained anymore and does not support DRF 3+ & Python 3.