django-rest-framework-naming-style 0.2

A toolkit for Django REST framework to easily switch APIs' naming styles.

This is a toolkit supporting camel case and snake case APIs’ naming styles and easily switch.

I wrote this with Django 2.0 and Django REST framework 3.7.3, but I think it can easily work with other versions of Django and DRF.

Requirements

• Python (2.7+)
• Django
• Django REST framework

Installation

Install using pip

pip install django-rest-framework-naming-style

Replace renderer and parser classes for JSON in your REST_FRAMEWORK setting

REST_FRAMEWORK = {
    ...
    'DEFAULT_RENDERER_CLASSES': (
        'django_rest_framework_naming_style.renderer.StylesJSONRenderer',
        # 'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ),
    'DEFAULT_PARSER_CLASSES': (
        'django_rest_framework_naming_style.parser.StylesJSONParser',
        # 'rest_framework.parsers.JSONParser',
        'rest_framework.parsers.FormParser',
        'rest_framework.parsers.MultiPartParser',
    ),
    ...
}

Make a monkey patch in django’s manage.py

# Make patching before `execute_from_command_line(sys.argv)`
from django_rest_framework_naming_style.monkey import monkey_patch
    monkey_patch()

execute_from_command_line(sys.argv)

Optional Settings

There are settings of this package with default value, options.

REST_FRAMEWORK_NAMING_STYLE = {
    'STYLE_KEY': 'STYLE',  # set a header key
    'STYLE_DEFAULT': 'underscore',  # underscore/camelcase
}

STYLE_KEY that you set accept a value in request headers between underscore and camelcase to specify one naming style of APIs unless you set style in view object to specify it.

If you set STYLE_KEY None, the style only depends on style in view object or STYLE_DEFAULT as you like.

Thank you for using django-rest-framework-naming-style.