Add SerializedRelatedField for write-by-slug, read-as-nested representation#9784
Open
HosseinSayyedMousavi wants to merge 1 commit intoencode:mainfrom
Open
Conversation
…tation - Introduce SerializedRelatedField in rest_framework/relations.py - Supports writing by slug/PK and reading as nested serializer - Add corresponding tests in tests/test_relations.py
4c7ab6e to
67a800b
Compare
Contributor
|
DRF is considered to be featured complete as per the contributing guidlines. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add
SerializedRelatedFieldfor write-by-slug, read-as-nested representationDescription
Currently,
SlugRelatedFieldonly returns the slug value (e.g. a PK or custom field).Nested serializers, on the other hand, expand the related object but require verbose input payloads.
In many APIs, developers want a hybrid behavior:
"address": 5)This PR introduces
SerializedRelatedField, which:SlugRelatedFieldon writesserializer_classis provided)Example
Request
{ "address": 5 }Response
{ "address": { "id": 5, "province": "Tehran", "city": "Tehran", "street": "Valiasr", "additional_info": "Test info" } }References
Testing
Tested locally using
django.test.TestCase:Covers both:
💡 Note: This feature provides a more convenient and expressive way to handle related fields in DRF, reducing boilerplate code and improving API readability.