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 Distribution
Built Distribution
Close
Hashes for django_rest_framework_redocs-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e50c7171e6563eb860dbce89e6c9eb6bb404b86b80d5f0ab968db99307bac085 |
|
MD5 | cbf8eb6003926209b7b23cd0c6a2aebf |
|
BLAKE2b-256 | 5679120891040c212a21074f467137aa2c219b12bde50a101960ffd12164c3cc |
Close
Hashes for django_rest_framework_redocs-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57d8dde8b1d74dfb818ea84e01cd73e16c811571e18331f9a376004c6a82d922 |
|
MD5 | ba8be0ec7a0e5f4513df6ab69c6247da |
|
BLAKE2b-256 | b45e319638c98259327f6ab45e7ededf6113731263713d07a0669c1519fbf7cc |