Django REST Framework XML

Warnings

• breaking Version 2.0.0 of djangorestframework-xml dropped support for Python 2.x. It also updated its minimum dependency requirements to Django 2.2+ and Django REST Framework 3.11+.
  Fix: Upgrade your Python environment to Python 3.5+ (preferably 3.8+ for current Django/DRF compatibility) and ensure your Django is 2.2+ and Django REST Framework is 3.11+ before upgrading to djangorestframework-xml v2.0.0 or newer.
• gotcha The default XML format generated by djangorestframework-xml is an 'ad-hoc' informal style. If your API has specific XML schema requirements (e.g., RSS, Atom, or a custom DTD), the default renderer/parser may not be sufficient. You may need to implement custom XML renderers and parsers.
  Fix: For specific XML output requirements, extend `XMLRenderer` and/or `XMLParser` to customize the `root_tag_name`, `item_tag_name`, or completely override rendering/parsing logic to match your desired XML structure.
• gotcha djangorestframework-xml requires the `defusedxml` package for security purposes. Failing to install it could expose your application to XML-related vulnerabilities.
  Fix: Ensure `defusedxml` is explicitly installed in your environment: `pip install defusedxml`. It is listed as a required dependency, but an explicit check is good practice.
• gotcha Clients making requests with XML payloads must send the correct `Content-Type` header (e.g., `application/xml`) for `XMLParser` to correctly process the data. Without it, DRF might default to `JSONParser` or another parser, leading to errors.
  Fix: Ensure that API clients explicitly set the `Content-Type` header to `application/xml` when submitting XML data to your endpoints.
• gotcha The default `XMLRenderer` might have limitations with deeply nested data structures or specific XML attribute requirements. Advanced XML structures may require further customization.
  Fix: For complex nested XML or precise attribute placement, you may need to fine-tune your DRF serializers or create a custom `XMLRenderer` that extends the base to handle your specific needs.

Install

• pip install djangorestframework-xml Install stable version

Imports

• XMLParser

  from rest_framework_xml.parsers import XMLParser

• XMLRenderer

  from rest_framework_xml.renderers import XMLRenderer

• StringIO
  wrong:

  from rest_framework.compat import StringIO

  correct:
  In older versions (prior to 1.0.1 and 1.4.0), there were issues with importing `StringIO` and `smart_text` from `rest_framework.compat`. These were fixed, and direct usage of Python's standard `io.StringIO` or appropriate text handling is now expected if needed. The library itself handles its internal compatibility.

Quickstart

To enable XML support globally, add `XMLParser` and `XMLRenderer` to your `REST_FRAMEWORK` settings in `settings.py`. For view-specific control, you can apply `@parser_classes` and `@renderer_classes` decorators to function-based views or set `parser_classes` and `renderer_classes` attributes in class-based views. Ensure `rest_framework_xml` is in your `INSTALLED_APPS` (though often not strictly necessary for just renderers/parsers, it's good practice).

import os

# settings.py
# Add 'rest_framework_xml' to INSTALLED_APPS if using specific template renderers or custom configurations
INSTALLED_APPS = [
    # ... other Django apps
    'rest_framework',
    'rest_framework_xml',
]

REST_FRAMEWORK = {
    'DEFAULT_PARSER_CLASSES': [
        'rest_framework.parsers.JSONParser',
        'rest_framework_xml.parsers.XMLParser',
    ],
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
        'rest_framework_xml.renderers.XMLRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer' # Optional: for DRF's browsable API
    ],
}

# views.py example
from rest_framework.decorators import api_view, renderer_classes, parser_classes
from rest_framework.response import Response
from rest_framework_xml.parsers import XMLParser
from rest_framework_xml.renderers import XMLRenderer

@api_view(['GET', 'POST'])
@parser_classes([XMLParser])
@renderer_classes([XMLRenderer])
def example_xml_view(request):
    """ A view that can accept/return XML content. """
    if request.method == 'GET':
        data = {'message': 'Hello from XML API!', 'status': 'success'}
        return Response(data)
    elif request.method == 'POST':
        received_data = request.data
        # Process received_data (which will be parsed from XML)
        return Response({'received_data': received_data, 'processed': True})