Django Rest 框架：serializers.ReadOnlyField() 不显示可浏览 api 中的字段

Django Rest Framework：如何在可浏览的 api 中显示只读字段？

当我添加result = serializers.CharField(read_only=True)对于我的模型序列化器，表单不再呈现结果字段。

我了解用户删除disabled表单输入上的属性（尽管我很惊讶 django 本身没有处理这个问题），那么我如何在 api.html 模板中实现只读字段result?

序列化器.py

class SnippetSerializer(serializers.HyperlinkedModelSerializer):
owner = serializers.ReadOnlyField(source='owner.username')
result = serializers.CharField(read_only=True)

class Meta:
    model = Snippet
    fields = ('title', 'code', 'owner', 'url', 'result')

我是 django-rest 框架的新手，所以任何帮助将不胜感激！

您有 2 个选择：

1. 要么计算模型中的结果

2. 或在序列化中添加字段

您的选择取决于您是否想在其他地方使用该计算结果以及您是否可以触摸模型。

当你想计算模型中的结果时

遵循 Django 派生全名的示例，位于以下位置：https://github.com/django/django/blob/master/django/contrib/auth/models.py#L348

或者在文档中解释：https://docs.djangoproject.com/en/dev/topics/db/models/#model-methods

这将自动充当 DRF 的只读字段。

您可以在下面的代码中看到用法（get_full_name）。

当您想在序列化中添加字段时

您可以在 DRF 文档中找到答案：http://www.django-rest-framework.org/api-guide/fields/#serializermethodfield

序列化方法字段这是一个只读字段...它可用于将任何类型的数据添加到对象的序列化表示中。

Serializers.py 中的 hour_since_joined 示例：

from django.contrib.auth.models import User, Group
from rest_framework import serializers
from django.utils.timezone import now

class UserSerializer(serializers.HyperlinkedModelSerializer):
    hours_since_joined = serializers.SerializerMethodField()
    class Meta:
        model = User
        fields = ('url', 'username', 'email', 'groups', 'hours_since_joined', 'first_name', 'last_name', 'get_full_name' )

    def get_hours_since_joined(self, obj):
        return (now() - obj.date_joined).total_seconds() // 3600

class GroupSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Group
        fields = ('url', 'name', 'user_set')

对于你的情况：

class SnippetSerializer(serializers.HyperlinkedModelSerializer):
    owner = serializers.ReadOnlyField(source='owner.username')
    result = serializers.SerializerMethodField()

    class Meta:
        model = Snippet
        fields = ('title', 'code', 'owner', 'url', 'result')

    def get_result(self, obj):
        # code here to calculate the result
        # or return obj.calc_result() if you have that calculation in the model
        return "some result"

显示 DRF 可浏览 API 中添加的字段

您需要在元字段中列出它们 - 请参阅上面的示例。这将在请求的可浏览输出中呈现该内容。但是，它不会在 DRF 的 HTML 表单中显示它们。原因是HTML表单仅用于提交信息，因此restframework模板在渲染时跳过了只读字段。

正如您所看到的，加入后的全名和小时数并未呈现在表单中，但可用于 API：

如果您想在表单上也显示只读字段

您需要覆盖restframework模板。

• 确保您的模板在其余框架之前加载（如果您的应用程序位于 settings.py 中的其余框架之上）
• 使用应用程序下的模板目录
• 在模板目录中创建子目录：restframework/horizo​​ntal

• 从Python的Lib\site-packages\rest_framework\templates\rest_framework\horizo​​ntal\复制form.html和input.html

• 更改form.html

{% load rest_framework %}
{% for field in form %}
    {% render_field field style=style %}
{% endfor %}

• 更改 input.html 中的输入行（添加禁用属性）

  <input name="{{ field.name }}"  {% if field.read_only %}disabled{% endif %} {% if style.input_type != "file" %}class="form-control"{% endif %} type="{{ style.input_type }}" {% if style.placeholder %}placeholder="{{ style.placeholder }}"{% endif %} {% if field.value %}value="{{ field.value }}"{% endif %}>
  

结果：