encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-26 08:00:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Juan Riaza 2013-01-05 23:43:53 +01:00
parent 0234b6161b
commit f223cf70e9
4 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -35,6 +35,8 @@ There is also a sandbox API you can use for testing purposes, [available here][s
* [Markdown] - Markdown support for the self describing API.
* [PyYAML] - YAML content type support.
* [msgpack-python] - MessagePack content type support.
* [python-dateutil] - Date parsing for MessagePack.
* [django-filter] - Filtering support.
# Installation
@ -284,4 +286,5 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[markdown]: http://pypi.python.org/pypi/Markdown/
[pyyaml]: http://pypi.python.org/pypi/PyYAML
[django-filter]: https://github.com/alex/django-filter
[msgpack-python]: https://github.com/msgpack/msgpack-python
[python-dateutil]: http://labix.org/python-dateutil

6
docs/api-guide/parsers.md
View File

@ -61,6 +61,12 @@ Parses `YAML` request content.
**.media_type**: `application/yaml`
## MessagePackParser
Parses `MessagePack` request content.
**.media_type**: `application/msgpack`
## XMLParser
Parses REST framework's default style of `XML` request content.

8
docs/api-guide/renderers.md
View File

@ -94,6 +94,14 @@ Renders the request data into `YAML`.
**.format**: `'.yaml'`
## MessagePackRenderer
Renders the request data into `MessagePack`.
**.media_type**: `application/msgpack`
**.format**: `'.msgpack'`
## XMLRenderer
Renders REST framework's default style of `XML` response content.

4
docs/index.md
View File

@ -35,6 +35,8 @@ The following packages are optional:
* [Markdown][markdown] (2.1.0+) - Markdown support for the browseable API.
* [PyYAML][yaml] (3.10+) - YAML content-type support.
* [django-filter][django-filter] (0.5.4+) - Filtering support.
* [python-dateutil] - Date parsing for MessagePack.
* [django-filter] - Filtering support.
## Installation
@ -167,6 +169,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[markdown]: http://pypi.python.org/pypi/Markdown/
[yaml]: http://pypi.python.org/pypi/PyYAML
[django-filter]: https://github.com/alex/django-filter
[msgpack-python]: https://github.com/msgpack/msgpack-python
[python-dateutil]: http://labix.org/python-dateutil
[0.4]: https://github.com/tomchristie/django-rest-framework/tree/0.4.X
[image]: img/quickstart.png
[sandbox]: http://restframework.herokuapp.com/