encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-02-04 05:34:40 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3866 from ekonstantinidis/more-drf-docs-info

Browse Source 
Mention Live API Endpoints for DRF Docs
This commit is contained in:
Xavier Ordoquy 2016-01-24 00:14:49 +01:00
commit f2d6013134
2 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/img/drfdocs.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 298 KiB

After

Width:  |  Height:  |  Size: 567 KiB

2
docs/topics/documenting-your-api.md
View File

@ -14,7 +14,7 @@ The most common way to document Web APIs today is to produce documentation that
#### DRF Docs #### DRF Docs
[DRF Docs][drfdocs-repo] allows you to document Web APIs made with Django REST Framework and it is authored by Emmanouil Konstantinidis. It's made to work out of the box and its setup should not take more than a couple of minutes. Complete documentation can be found on the [website][drfdocs-website] while there is also a [demo][drfdocs-demo] available for people to see what it looks like. [DRF Docs][drfdocs-repo] allows you to document Web APIs made with Django REST Framework and it is authored by Emmanouil Konstantinidis. It's made to work out of the box and its setup should not take more than a couple of minutes. Complete documentation can be found on the [website][drfdocs-website] while there is also a [demo][drfdocs-demo] available for people to see what it looks like. **Live API Endpoints** allow you to utilize the endpoints from within the documentation in a neat way.
Features include customizing the template with your branding, settings for hiding the docs depending on the environment and more. Features include customizing the template with your branding, settings for hiding the docs depending on the environment and more.