Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manosim/django-rest-framework-docs
Document Web APIs made with Django Rest Framework
https://github.com/manosim/django-rest-framework-docs
django django-rest-framework docs pypi web-api
Last synced: 3 months ago
JSON representation
Document Web APIs made with Django Rest Framework
- Host: GitHub
- URL: https://github.com/manosim/django-rest-framework-docs
- Owner: manosim
- License: bsd-2-clause
- Created: 2015-12-11T20:44:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-01-11T09:27:44.000Z (almost 3 years ago)
- Last Synced: 2024-05-20T23:37:32.950Z (6 months ago)
- Topics: django, django-rest-framework, docs, pypi, web-api
- Language: Python
- Homepage: https://www.drfdocs.com/
- Size: 4.61 MB
- Stars: 643
- Watchers: 22
- Forks: 184
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - django-rest-framework-docs - Document Web APIs made with Django Rest Framework (Python)
README
# [DRF Docs](http://www.drfdocs.com/) [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url] [![pypi][pypi-image]][pypi-url] [![slack][slack-image]][slack-url]
Document Web APIs made with Django Rest Framework. [View Demo](http://demo.drfdocs.com/)
> **Contributors Wanted**: Do you like this project? Using it? Let's make it better!
### Supports
- Python (2.7, 3.3, 3.4, 3.5)
- Django (1.8, 1.9)
- Django Rest Framework (3+)
### Documentation - Table of contents
- [Installation](http://drfdocs.com/installation/)
- [Settings](http://drfdocs.com/settings/)
- [Extending the template](http://drfdocs.com/templates/)
- [Live API Endpoints](http://drfdocs.com/live-api/)
- [Contributing & Development](http://drfdocs.com/contributing/)
- [Changelog](http://drfdocs.com/changelog/)
### Development & Demo Project
If you are looking to develop this package with one of your own django projects:
pyvenv env
env/bin/pip install -r requirements.txt
pip install -e ~/Projects/drf-docs/
If you want to use the demo app to work on this package:
Included in this repo you can find the demo project(at `/demo`). It is a project with *Django* & *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please check the [README.md](demo/README.md) of the demo project.
For more information visit [the docs](http://drfdocs.com/contributing/).
### Installation
Install using pip:
pip install drfdocs
Add 'rest_framework_docs' to your `INSTALLED_APPS` setting:
INSTALLED_APPS = (
...
'rest_framework_docs',
)
Finally include the `rest_framework_docs` urls in your `urls.py`:
urlpatterns = [
...
url(r'^docs/', include('rest_framework_docs.urls')),
]
### Settings
You can find detailed information about the package's settings at [the docs](http://drfdocs.com/settings/).
REST_FRAMEWORK_DOCS = {
'HIDE_DOCS': True # Default: False
}
### Credits
First of all thanks to the [Django](http://www.djangoproject.com/) core team and to all the contributors of [Django REST Framework](http://www.django-rest-framework.org/) for their amazing work. Also I would like to thank [Marc Gibbons](https://github.com/marcgibbons) for his *django-rest-framework-docs* project. Both projects share the same idea, it is just that Marc's is not maintained anymore and does not support DRF 3+ & Python 3.
[travis-image]: https://travis-ci.org/manosim/django-rest-framework-docs.svg?branch=master
[travis-url]: https://travis-ci.org/manosim/django-rest-framework-docs
[pypi-image]: https://badge.fury.io/py/drfdocs.svg
[pypi-url]: https://pypi.python.org/pypi/drfdocs/
[codecov-image]: https://codecov.io/github/manosim/django-rest-framework-docs/coverage.svg?branch=master
[codecov-url]:https://codecov.io/github/manosim/django-rest-framework-docs?branch=master
[slack-image]: https://img.shields.io/badge/slack-pythondev/drfdocs-e01563.svg
[slack-url]: https://pythondev.slack.com