Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpadilla/django-rest-framework-xml
XML support for Django REST Framework
https://github.com/jpadilla/django-rest-framework-xml
django django-rest-framework python
Last synced: about 2 months ago
JSON representation
XML support for Django REST Framework
- Host: GitHub
- URL: https://github.com/jpadilla/django-rest-framework-xml
- Owner: jpadilla
- License: bsd-3-clause
- Created: 2014-11-27T16:52:02.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-09-18T07:22:39.000Z (about 1 year ago)
- Last Synced: 2024-07-19T07:55:02.966Z (2 months ago)
- Topics: django, django-rest-framework, python
- Language: Python
- Homepage: http://jpadilla.github.io/django-rest-framework-xml
- Size: 1.11 MB
- Stars: 85
- Watchers: 9
- Forks: 59
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-django-rest-framework - django-rest-framework-xml
README
# REST Framework XML
[![build-status-image]][github-action]
[![pypi-version]][pypi]
**XML support for Django REST Framework**
Full documentation for the project is available at [http://jpadilla.github.io/django-rest-framework-xml][docs].
## Overview
XML support extracted as a third party package directly from the official Django REST Framework implementation. It requires the [defusedxml][defusedxml] package only because it safeguards against some security issues that were discovered.
**Note**: XML output provided is an ad-hoc format that isn't formally described. If you have specific XML requirements you'll need to write your own XML parsers/renderers in order to fully control the representation.
## Requirements
* Python 3.5+
* Django 2.2+
* Django REST Framework 3.11+
## Installation
Install using `pip`...
```bash
$ pip install djangorestframework-xml
```
## Example
```python
REST_FRAMEWORK = {
'DEFAULT_PARSER_CLASSES': (
'rest_framework_xml.parsers.XMLParser',
),
'DEFAULT_RENDERER_CLASSES': (
'rest_framework_xml.renderers.XMLRenderer',
),
}
```
You can also set the renderer and parser used for an individual view, or viewset, using the APIView class based views.
```python
from rest_framework import routers, serializers, viewsets
from rest_framework_xml.parsers import XMLParser
from rest_framework_xml.renderers import XMLRenderer
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ('url', 'username', 'email', 'is_staff')
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
parser_classes = (XMLParser,)
renderer_classes = (XMLRenderer,)
```
### Sample output
```xml
http://127.0.0.1:8000/users/1/.xml
jpadilla
[email protected]
True
```
## Documentation & Support
Full documentation for the project is available at [http://jpadilla.github.io/django-rest-framework-xml][docs].
You may also want to follow the [author][jpadilla] on Twitter.
[build-status-image]: https://github.com/jpadilla/django-rest-framework-xml/workflows/CI/badge.svg
[github-action]: https://github.com/jpadilla/django-rest-framework-xml/actions?query=workflow%3ACI
[pypi-version]: https://img.shields.io/pypi/v/djangorestframework-xml.svg
[pypi]: https://pypi.python.org/pypi/djangorestframework-xml
[defusedxml]: https://pypi.python.org/pypi/defusedxml
[docs]: http://jpadilla.github.io/django-rest-framework-xml
[jpadilla]: https://twitter.com/jpadilla_