The following view demonstrates an example of using a serializer in a template for viewing and updating a model instance: Serializers may be rendered as forms by using the render_form template tag, and including the serializer instance as context to the template. Views.py: from my_ import Profileįrom rest_framework.renderers import TemplateHTMLRendererįrom rest_framework.response import Response Here's an example of a view that returns a list of "Profile" instances, rendered in an HTML template: The StaticHTMLRender class expects the response to contain a string of the pre-rendered HTML content.īecause static HTML pages typically have different behavior from API responses you'll probably need to write any HTML views explicitly, rather than relying on the built-in generic views. The TemplateHTMLRenderer class expects the response to contain a dictionary of context data, and renders an HTML page based on a template that must be specified either in the view or on the response. In order to return HTML responses you'll need to use either TemplateHTMLRenderer, or StaticHTMLRenderer. Additionally, serializers can be used as HTML forms and rendered in templates. Updated_ framework is suitable for returning both API style responses, and regular HTML pages. Updated_instance = super(PostSerializer, self).update(instance, validated_data) class CommentSerializer(EmbeddedDocumentSerializer):ĭef update(self, instance, validated_data):Ĭomments = validated_data.pop('comments') update() is provided because CommentSerializer has kwarg many=True. update() methods.įor example, as you see below, custom. There is a workaround which is supplying. On DRF 3, when you set serializer with many=True kwarg, it automatically converts to ListSerializer, which will lead to a nested serializer exception (from DRF). Warning About EmbeddedDocumentSerializer(many=True) Note:Calling EmbeddedDocumentSerializer.save() will raise an exception, because EmbeddedDocuments need a Document to attach to. You dont have to implement when nesting EmbeddedDocumentSerializer, it is done automatically for you on the go while (de)serializing. Unlike DocumentSerializer, behavior on EmbeddedDocuments are not ambiguous. With great power, comes great responsibility. It can be risky to save any data that comes with request, so use use it at your own risk. Any extra key-value combination on request.data will be saved. See Mongoengine docs for further info.ĭynamicDocumentSerializer is built to support that feature. Using DynamicDocuments, you can save any extra attributes without defining excplicitly on the model. Sample Implementation from rest_framework_rializers import DocumentSerializer, EmbeddedDocumentSerializerĬlass ExtensionSerializer(EmbeddedDocumentSerializer):Ĭlass BlogSerializer(DocumentSerializer):Įxtension = ExtensionSerializer(many=False)įields = ('id', 'blog', 'author', 'text', 'comments', 'extension') See DRF documentationįor using DocumentSerializer as nested serializer, you have to implement it manually like documented. Instead, you can explicitly define your nested-serialization behavior. You can use nested serializers.įor concerns about ambiguity and complexity about automatic nested serialization, Django Rest Framework has decided to NOT to do it. In many cases, you may want to customize serialization process. If you want that to restrict users and improve validation on compound fields, you should use nested serializers. For example ListField(User), serializer can not know User's fields and their kwargs.
But on compound fields like ListField, EmbeddedDocumentField, there is no kwarg to pass for validation. "further_read": "See Tom's post about Mongoengine"ĭocumentSerializer can get basic-field's (like StringField) kwargs and pass it to serializer for validation. "text": "Yet another new post about MongoDB", Serializers.py from rest_framework_rializers import DocumentSerializerĬlass PostSerializer(DocumentSerializer): Is_approved = BooleanField(default=False)Ĭomments = ListField(EmbeddedDocumentField(Comment))Įxtension = EmbeddedDocumentField(BlogExtension) Sample Implementationįriends = ListField(ReferenceField('self'))įurther_read = StringField(required=True) If you are not familiar with DRF ModelSerializer, you should first visit it's documentation page.įor basic implementation, DocumentSerializer works similar to ModelSerializer. DocumentSerializer is a subclass of DRF's ModelSerializer.
0 kommentar(er)
