Skip to main content

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

```
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

<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.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_rest_framework_redocs-0.0.7-py2.py3-none-any.whl (11.3 kB) Copy SHA256 hash SHA256 Wheel py2.py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page