重命名響應字段django rest框架序列化程序

Question

我使用djangorestframework調用一個簡單的get API。我的模型是

class Category(models.Model): 
    category_id = models.AutoField(primary_key=True) 
    category_name = models.CharField("Category Name", max_length = 30) 
    category_created_date = models.DateField(auto_now = True, auto_now_add=False) 
    category_updated_date = models.DateField(auto_now = True, auto_now_add=False) 

    def __str__(self): 
     return self.category_name 

serializer.py

class CategorySerializer(serializers.ModelSerializer) : 
    class Meta: 
     model = Category 
     fields = ['category_id', 'category_name'] 

def category_list(request): 
    if request.method == 'GET': 
     categories = Category.objects.all() 
     serializer = CategorySerializer(categories, many=True) 
     return Response(serializer.data) 

它的工作很好，當我打的URL請求，並返回下面的響應。

[ 
    { 
     "category_id": 1, 
     "category_name": "ABC" 
    } 
] 

我想改變的響應字段的名稱，因爲它是隻有我的DB和不願響應透露。如果我更改序列化程序類中的名稱，則不會發出字段匹配錯誤。

另外我想定製其他參數像上面的響應對象與消息和狀態如下。

{ 
status : 200, 
message : "Category List", 
response : [ 
     { 
      "id": 1, 
      "name": "ABC" 
     } 
    ] 
} 

需要適當的指導和流程。專家幫助。

Answer 1

首先所有使用category_的字段名都是多餘的。因爲您已經將此字段分配給Category模型，並且通過執行此操作，您正在爲此字段創建「名稱空間」。

class Category(models.Model): 
    id = models.AutoField(primary_key=True) 
    name = models.CharField("Category Name", max_length = 30) 
    created_date = models.DateField(auto_now = True, auto_now_add=False) 
    updated_date = models.DateField(auto_now = True, auto_now_add=False) 

    def __str__(self): 
     return self.name 

二在Django id下拉列表AutoField被自動創建，爲什麼你需要設置明確？

並回答您的問題序列化程序字段中有source參數。

class CategorySerializer(serializers.ModelSerializer): 
    renamed_id = serializers.IntegerField(source='category_id') 
    renamed_name = serializers.CharField(source='category_name') 

    class Meta: 
     model = Category 
     fields = ['renamed_id', 'renamed_name'] 

而且比你可以改變你的迴應手動

from rest_framework import status 

def category_list(request): 
    if request.method == 'GET': 
     categories = Category.objects.all() 
     serializer = CategorySerializer(categories, many=True) 
     response = { 
      'status': status.HTTP_200_OK, 
      'message' : "Category List", 
      'response' : serializer.data 
     } 
     return Response(response) 

Answer 2

您可以在序列化程序中覆蓋to_representation函數。請檢查以下代碼，您可以根據需要更新data字典。

class CategorySerializer(serializers.ModelSerializer) : 
    class Meta: 
     model = Category 
     fields = ['category_id', 'category_name'] 
    def to_representation(self, instance): 
     data = super(CategorySerializer, self).to_representation(instance) 
     result_data={"status" : 200,"message" : "Category List"} 
     result_data["response"]=data 
     return result_data 

Answer 3

你可以把它包裝在json。這是你呈現你想要的方式的方式：

from django.http import HttpResponse 
import json 

def category_list(request): 
    if request.method == 'GET': 
     categories = Category.objects.all() 
     serializer = CategorySerializer(categories, many=True) 
     response = {'code: 200, 'message': 'Category List', 'response': serializer.data} 
     return HttpResponse(json.dumps(response), mimetype='application/json') 

這是你可以爲你的字段的方式：

class CategorySerializer(serializers.ModelSerializer): 
    name = serializers.CharField(source='category_name') 

    class Meta: 
     model = Category 
     fields = ['category_id', 'name'] 

這是docs用不同的名稱序列化。