diff options
| author | Tom Christie | 2014-11-28 14:43:33 +0000 | 
|---|---|---|
| committer | Tom Christie | 2014-11-28 14:43:33 +0000 | 
| commit | 9ba29a88d6674d65bf5e8438eba2a072f0d44bf1 (patch) | |
| tree | dc5fa51ac050c3baec1b5e5fdc051d13baf8618d /docs/api-guide | |
| parent | 8e549a76ea0ff6b44e1dcf08ba733a5fbfc004ed (diff) | |
| download | django-rest-framework-9ba29a88d6674d65bf5e8438eba2a072f0d44bf1.tar.bz2 | |
Finalizing 3.0 release notes
Diffstat (limited to 'docs/api-guide')
| -rw-r--r-- | docs/api-guide/serializers.md | 38 | 
1 files changed, 13 insertions, 25 deletions
| diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index 4d6c491f..0ee80d53 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -567,21 +567,22 @@ There needs to be a way of determining which views should be used for hyperlinki  By default hyperlinks are expected to correspond to a view name that matches the style `'{model_name}-detail'`, and looks up the instance by a `pk` keyword argument. -You can change the field that is used for object lookups by setting the `lookup_field` option. The value of this option should correspond both with a kwarg in the URL conf, and with a field on the model.  For example: +You can override a URL field view name and lookup field by using either, or both of, the `view_name` and `lookup_field` options in the `extra_field_kwargs` setting, like so:      class AccountSerializer(serializers.HyperlinkedModelSerializer):          class Meta:              model = Account -            fields = ('url', 'account_name', 'users', 'created') -            lookup_field = 'slug' - -Note that the `lookup_field` will be used as the default on *all* hyperlinked fields, including both the URL identity, and any hyperlinked relationships. +            fields = ('account_url', 'account_name', 'users', 'created') +            extra_field_kwargs = { +                'url': {'view_name': 'accounts', 'lookup_field': 'account_name'} +                'users': {'lookup_field': 'username'} +            } -For more specific requirements such as specifying a different lookup for each field, you'll want to set the fields on the serializer explicitly.  For example: +Alternatively you can set the fields on the serializer explicitly. For example:      class AccountSerializer(serializers.HyperlinkedModelSerializer):          url = serializers.HyperlinkedIdentityField( -            view_name='account-detail', +            view_name='accounts',              lookup_field='slug'          )          users = serializers.HyperlinkedRelatedField( @@ -595,28 +596,15 @@ For more specific requirements such as specifying a different lookup for each fi              model = Account              fields = ('url', 'account_name', 'users', 'created') -## Overriding the URL field behavior - -The name of the URL field defaults to 'url'.  You can override this globally, by using the `URL_FIELD_NAME` setting. - -You can also override this on a per-serializer basis by using the `url_field_name` option on the serializer, like so: +--- -    class AccountSerializer(serializers.HyperlinkedModelSerializer): -        class Meta: -            model = Account -            fields = ('account_url', 'account_name', 'users', 'created') -            url_field_name = 'account_url' +**Tip**: Properly matching together hyperlinked representations and your URL conf can sometimes be a bit fiddly. Printing the `repr` of a `HyperlinkedModelSerializer` instance is a particularly useful way to inspect exactly which view names and lookup fields the relationships are expected to map too. -**Note**: The generic view implementations normally generate a `Location` header in response to successful `POST` requests. Serializers using `url_field_name` option will not have this header automatically included by the view.  If you need to do so you will ned to also override the view's `get_success_headers()` method. +--- -You can also override the URL field's view name and lookup field without overriding the field explicitly, by using the `view_name` and `lookup_field` options, like so: +## Changing the URL field name -    class AccountSerializer(serializers.HyperlinkedModelSerializer): -        class Meta: -            model = Account -            fields = ('account_url', 'account_name', 'users', 'created') -            view_name = 'account_detail' -            lookup_field='account_name' +The name of the URL field defaults to 'url'.  You can override this globally, by using the `URL_FIELD_NAME` setting.  --- | 
