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
1 maintainer
Metadata
1 maintainer
Release files for django-rest-framework-redocs 0.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django_rest_framework_redocs-0.0.8.tar.gz | 11.3 kB | Without provenance | Details for django_rest_framework_redocs-0.0.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| django_rest_framework_redocs-0.0.8-py2-none-any.whl | Python 2 | none | any | Details for django_rest_framework_redocs-0.0.8-py2-none-any.whl |
Total release size: 23.7 kB
Release files / django_rest_framework_redocs-0.0.8.tar.gz
| Download URL | django_rest_framework_redocs-0.0.8.tar.gz |
|---|---|
| Size | 11.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
62cffb6b682c2fbaef74cbd8ffde8458537e5e44d633b564733ddd3d1a0f8ee8
|
|
BLAKE2b-256 checksum How to use checksums |
daee4a27a2a14c88045fb8b67393a9679b86422fc099149068c164f970dda719
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / django_rest_framework_redocs-0.0.8-py2-none-any.whl
| Download URL | django_rest_framework_redocs-0.0.8-py2-none-any.whl |
|---|---|
| Size | 12.4 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
39bbd4684c091ac745cf833c5c644e8c7b00238d0b5a8b45f87fa33ae8eca077
|
|
BLAKE2b-256 checksum How to use checksums |
e54b1c316916dda3c34696708851004b9eba98a11d9acd3fa1c467c55fcefeb1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for django-rest-framework-redocs 0.0.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
