Live API endpoints for django rest framework 1.x & 2.x
Project description
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
ReactSPA, and also uses several UMD builds served byunpkg - It uses
babel-standaloneto transform the embedded JS code on-the-fly, so if you want to modify something you can just edit the code inredocs/templates/index.htmlwithout 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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_rest_framework_redocs-0.0.8.tar.gz.
File metadata
- Download URL: django_rest_framework_redocs-0.0.8.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
62cffb6b682c2fbaef74cbd8ffde8458537e5e44d633b564733ddd3d1a0f8ee8
|
|
| MD5 |
12f5b9c0ecf13f320db20052a63b561b
|
|
| BLAKE2b-256 |
daee4a27a2a14c88045fb8b67393a9679b86422fc099149068c164f970dda719
|
File details
Details for the file django_rest_framework_redocs-0.0.8-py2-none-any.whl.
File metadata
- Download URL: django_rest_framework_redocs-0.0.8-py2-none-any.whl
- Upload date:
- Size: 12.4 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39bbd4684c091ac745cf833c5c644e8c7b00238d0b5a8b45f87fa33ae8eca077
|
|
| MD5 |
25fe40135791e6d0ec937b3cb9eb297c
|
|
| BLAKE2b-256 |
e54b1c316916dda3c34696708851004b9eba98a11d9acd3fa1c467c55fcefeb1
|
