Add a style to hide fields from raw data input from BrowsableAPIRenderer

[mdrkrg]

Problem

Sometimes we may not want a HiddenField but just a normal field to be hidden from the browsable API view's raw data input. For example:

• Validate both the query param and the body using one serializer, but don't want the param appear in the raw data.
• There are too many optional fields and we may only want to display crucial ones.

Idea

Adding a hide_raw_data flag to field styles would achieve this:

diff --git a/rest_framework/renderers.py b/rest_framework/renderers.py
index 6d7218bb..4cd3e584 100644
--- a/rest_framework/renderers.py
+++ b/rest_framework/renderers.py
@@ -590,7 +590,10 @@ class BrowsableAPIRenderer(BaseRenderer):
                 serializer = serializer.child if is_list_serializer else serializer
                 data = serializer.data.copy()
                 for name, field in serializer.fields.items():
-                    if isinstance(field, serializers.HiddenField):
+                    if (
+                        isinstance(field, serializers.HiddenField)
+                        or field.style.get('hide_raw_data')
+                    ):
                         data.pop(name, None)
                 data = [data] if is_list_serializer else data
                 content = renderer.render(data, accepted, context)

This is just a change in the renderer, so no other side effects of the HiddenField.

[mdrkrg]

Workaround if this is not implemented in DRF:

class HideFieldsMixin:
    def get_hide_raw_data_fields(self):
        return [
            name
            for name, field in self.fields.items()
            if field.style.get("hide_raw_data")
        ]

    @property
    def data(self):
        ret = super().data
        request = self.context.get("request")

        if request and isinstance(request.accepted_renderer, BrowsableAPIRenderer):
            for field_name in self.get_hide_raw_data_fields():
                ret.pop(field_name, None)
        return ret

class TestSerializer(HideFieldsMixin, serializers.Serializer):
    author = serializers.CharField(style={'hide_raw_data': True})