Document Web APIs made with Django Rest Framework.
- Python (3.3, 3.4, 3.5)
- Django (1.8, 1.9)
- Django Rest Framework (3+)
pyvenv env env/bin/pip install -r requirements.txt # To test within another django project pip install -e ~/Projects/drf-docs/ Install using pip:
pip install djangorestframeworkdocs Add 'rest_framework_docs' to your INSTALLED_APPS setting:
INSTALLED_APPS = ( ... 'rest_framework_docs', ) Finally include the rest_framework_docs urls in your urls.py:
urlpatterns = [ ... url(r'^docs/', include('rest_framework_docs.urls')), ] - Support Python 2 & Python 3
- Support DRF 3+
- Open Pull Request to include in DRF
- Submit to djangopackages.com
First of all thanks to the Django core team and to all the contributors of Django REST Framework for their amazing work. Also I would like to thank Marc Gibbons for his django-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.