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](https://github.com/manosim/django-rest-framework-docs) and [drf-autodocs](https://github.com/iMakedonsky/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
For now, please do `pip install git+https://github.com/whitedogg13/django-rest-framework-redocs`.
(We will publish it soon after some more tests!)
## 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
<div style="display: flex; align-items: center; justify-content: center; margin: 20px; position: relative;">
<img src="screenshots/drf-redocs-1.png" width="100%" >
</div>
<div style="display: flex; align-items: center; justify-content: center; margin: 20px; position: relative;">
<img src="screenshots/drf-redocs-2.png" width="100%" >
</div>
## 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](https://github.com/manosim/django-rest-framework-docs) and [drf-autodocs](https://github.com/iMakedonsky/drf-autodocs)
Automatically enable live API page for DRF, support both Django **1.x** and **2.x**!!
Inspired by [django-rest-framework-docs](https://github.com/manosim/django-rest-framework-docs) and [drf-autodocs](https://github.com/iMakedonsky/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
For now, please do `pip install git+https://github.com/whitedogg13/django-rest-framework-redocs`.
(We will publish it soon after some more tests!)
## 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
<div style="display: flex; align-items: center; justify-content: center; margin: 20px; position: relative;">
<img src="screenshots/drf-redocs-1.png" width="100%" >
</div>
<div style="display: flex; align-items: center; justify-content: center; margin: 20px; position: relative;">
<img src="screenshots/drf-redocs-2.png" width="100%" >
</div>
## 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](https://github.com/manosim/django-rest-framework-docs) and [drf-autodocs](https://github.com/iMakedonsky/drf-autodocs)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for django_rest_framework_redocs-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37037a52996a750c77336f20c4ee1657b3c0050828dfcd7ec6a57c3c97c0960a |
|
MD5 | 7604a595ff8bfce82f628e37a74888ba |
|
BLAKE2b-256 | ae8466ded1729cc6b41bd7aa5064421cd5ee4fb2e5cb942c5c15d3591a478ed5 |