Django REST framework url in json

Question

I noticed in the example REST framework site here http://restframework.herokuapp.com/snippets/ that there is a field called 'url' for each user which conveniently links to the user details page. Where on the Django REST documentation is their an example on how to achieve this, or can someone provide me with an example?

Answer 1

Use serializers.HyperlinkedModelSerializer and add 'url this should add the details part in.

Link: serializers.HyperlinkedModelSerializer

UPDATE:

You can add the ID in with the HyperlinkedModelSerializer just add....

  id = serializers.Field()

Done :)

Answer 2

There's an entire page of the tutorial dedicated to this topic: http://django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis.html

Check the section marked "Hyperlinking our API". It shows the code that defines the JSON you see in that page:

class SnippetSerializer(serializers.HyperlinkedModelSerializer):
    owner = serializers.Field(source='owner.username')
    highlight = serializers.HyperlinkedIdentityField(view_name='snippet-highlight', format='html')

    class Meta:
        model = models.Snippet
        fields = ('url', 'highlight', 'owner',
                  'title', 'code', 'linenos', 'language', 'style')