Django REST Frameworkシリアライザで検証エラーを発生させる際にエラーコードを指定する方法

Question

ユーザーにアカウントを登録できるAPIエンドポイントがあります。重複したユーザー名に対して400ではなくHTTP 409を返したいと思います。エラーがトリガされると

from django.contrib.auth.models import User 
from rest_framework.serializers import ModelSerializer 

class UserSerializer(ModelSerializer): 
    username = CharField() 

    def validate_username(self, value): 
     if User.objects.filter(username=value).exists(): 
      raise NameDuplicationError() 
     return value 


class NameDuplicationError(APIException): 
    status_code = status.HTTP_409_CONFLICT 
    default_detail = u'Duplicate Username' 

、応答は次のとおりです：{"detail":"Duplicate Username"}

は、ここに私のシリアライザです。 APIExceptionをサブクラス化すると、usernameの代わりにdetailというキーが使用されることに気付きました。

は、私が代わりに{"username":"Duplicate Username"}

この応答を持つようにしたいか、私はValidationErrorをを上げるステータスコードを指定したいと思います：

def validate_username(self, value): 
    if User.objects.filter(username=value).exists(): 
     raise serializers.ValidationError('Duplicate Username', 
              status_code=status.HTTP_409_CONFLICT) 
    return value 

をしかしValidationErrorのみ400

を返すので、これは動作しません。

これを達成する他の方法はありますか？

Answer 1

あなたは次のように別の例外を発生させることができます。

from rest_framework.exceptions import APIException 
from django.utils.encoding import force_text 
from rest_framework import status 


class CustomValidation(APIException): 
    status_code = status.HTTP_500_INTERNAL_SERVER_ERROR 
    default_detail = 'A server error occurred.' 

    def __init__(self, detail, field, status_code): 
     if status_code is not None:self.status_code = status_code 
     if detail is not None: 
      self.detail = {field: force_text(detail)} 
     else: self.detail = {'detail': force_text(self.default_detail)} 

あなたのようなあなたのシリアライザでこれを使用することができます

：

raise CustomValidation('Duplicate Username','username', status_code=status.HTTP_409_CONFLICT) 

または

raise CustomValidation('Access denied','username', status_code=status.HTTP_403_FORBIDDEN) 

Answer 2

使用ジャンゴ・休息・フレームワークのカスタム例外ハンドラhttp://www.django-rest-framework.org/api-guide/exceptions/

def custom_exception_handler(exc, context=None): 
    response = exception_handler(exc, context) 
    if response is not None: 
     if response.data['detail'] == 'Duplicate Username': 
      response.data['username'] = response.data.pop('detail') 
     response.status_code = status.HTTP_409_CONFLICT 
    return response