Django REST Framework ReDocs

Automatically enable live API page for DRF, support both Django 1.x and 2.x!!

Inspired by django-rest-framework-docs and drf-autodocs, thanks for their great work!

Features

• Support Django 1.8+ ~ 2.x, yah!
• Automatic API endpoints detection
• Automatic API page generation
• Support applicatioin/json or multipart/form-data encoding
• Support FileField, so you can test file upload
• Support token auth
• API filtering

Installation

pip install django_rest_framework_redocs

Dependencies

For backend, this project only depends on django and django-rest-framework.

For frontend:

• It's a React SPA, and also uses several UMD builds served by unpkg
• It uses babel-standalone to transform the embedded JS code on-the-fly, so if you want to modify something you can just edit the code in redocs/templates/index.html without any prior setup and it should just work!

Screenshot

Feature request

Just open an issue to let us know your idea!

Contributions

Contributions are welcome! We need your help to make this project better!

Special Thanks

The automatic endpoint detection algorithm is adapted from django-rest-framework-docs and drf-autodocs