Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/macagua/example.django.rest_framework.tutorial

Django Rest Framework 3.9.1 Quickstart Tutorial
https://github.com/macagua/example.django.rest_framework.tutorial

django django-example django-rest-framework django-web examples examples-python practice quickstart-tutorial tutorial

Last synced: about 7 hours ago
JSON representation

Django Rest Framework 3.9.1 Quickstart Tutorial

Awesome Lists containing this project

README 

        
# example.django.rest_framework.tutorial



My practices about the following tutorials:



- [Django 1.9 Project tutorial](https://docs.djangoproject.com/en/1.9/intro/).

- [Django Rest Framework 3.9.1 tutorial Quickstart](http://www.django-rest-framework.org/tutorial/quickstart/).

- [Desarrollo de un API REST con Django REST framework, tutorial 1: Serialización](http://jonathanpumares.com/desarrollo-de-un-api-rest-con-django-rest-framework-tutorial-1-serializacion/).



## Installation



This Django Web app need a lot of Python extras packages, please execute the following command:



```bash

$ pip install -r requirements.txt --timeout 120

```



### Build the Django Web app DB



```bash

$ python manage.py makemigrations

$ python manage.py migrate

```

### Create Django Admin User



This Django Web app need a to create a Django Admin User, for access and manager the Admin interface, please execute the following command:



**Tip:** for this local installation use the user as **admin** and password as **password123**.



```bash

$ python manage.py createsuperuser --email [email protected] --username admin

Password: 

Password (again): 

Superuser created successfully.

```



## Run the Django Web app



You need to run the Django server, please execute the following command:



```bash

$ python manage.py runserver

```



- Open your web browser with the following URL: [http://0.0.0.0:8000/](http://0.0.0.0:8000/) and see the Django Web app.



- Open your web browser with the following URL: [http://0.0.0.0:8000/admin/](http://0.0.0.0:8000/admin/) and see the Django Admin Interface, use the user **admin** and password **password123**.



**Tip:** PLEASE add two **groups**, two **users** and later add a user into a group.



### Quickstart App



For add data for *Quickstart* App, please access to the following URL: [http://localhost:8000/admin/quickstart/](http://localhost:8000/admin/quickstart/)



### Snippets App



For add data for *Snippets* App, please access to the following URL: [http://localhost:8000/admin/snippets/](http://localhost:8000/admin/snippets/)



### Testing the API



You have many APIs Rest for testing, now access to the APIs, both from the command-line, using tools like **curl**, please execute the following command:



#### Users endpoint



For testing the **users** API Rest, please execute the following command:



```bash

$ curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/users/

[

    {

        "url": "http://127.0.0.1:8000/users/4/",

        "username": "rocio",

        "email": "[email protected]",

        "groups": [

            "http://127.0.0.1:8000/groups/3/"

        ]

    },

    {

        "url": "http://127.0.0.1:8000/users/3/",

        "username": "leonardo",

        "email": "[email protected]",

        "groups": [

            "http://127.0.0.1:8000/groups/2/"

        ]

    },

    {

        "url": "http://127.0.0.1:8000/users/1/",

        "username": "admin",

        "email": "[email protected]",

        "groups": []

    }

]

```



#### Groups endpoint



For testing the **groups** API Rest, please execute the following command:



```bash

$ curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/groups/

[

    {

        "url": "http://127.0.0.1:8000/groups/1/",

        "name": "Administrators"

    },

    {

        "url": "http://127.0.0.1:8000/groups/2/",

        "name": "Plone"

    },

    {

        "url": "http://127.0.0.1:8000/groups/3/",

        "name": "Botana"

    }

]

```



#### Events endpoint



For testing the **events** API Rest, please execute the following command:



```bash

$ curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/events/

[

    {

        "name": "New Plone release for 2018",

        "description": "Plone will be release a new version at PloneConf 2018",

        "room_number": 201,

        "start_date": "2018-02-13T19:42:31Z",

        "finish_date": "2018-02-14T19:42:37Z"

    },

    {

        "name": "New Django release",

        "description": "Django will be release a new version at DjangoConf 2018",

        "room_number": 101,

        "start_date": "2018-02-12T19:40:59Z",

        "finish_date": "2018-02-12T20:41:04Z"

    }

]

```



#### Blog post endpoint



For testing the **blog post** API Rest, please execute the following command:



```bash

$ curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/blog-post/

[

    {

        "title": "Django project will be release a new version soon",

        "content": "Django will be release a new version at DjangoConf 2018"

    },

    {

        "title": "Plone is Cool",

        "content": "Plone is still in fashion with the latest Web technologies"

    }

]

```



#### Comments endpoint



For testing the **comments** API Rest, please execute the following command:



```bash

$ curl -H 'Accept: application/json; indent=4' -u admin:password123 http://127.0.0.1:8000/comments/

[

    {

        "email": "[email protected]",

        "content": "I want to dowload and test it",

        "created": "2018-02-03T19:46:43Z"

    },

    {

        "email": "[email protected]",

        "content": "#FuckYou Djanguero",

        "created": "2018-02-03T19:22:02Z"

    },

    {

        "email": "[email protected]",

        "content": "You are very pathetic you are still using Plone",

        "created": "2018-02-03T19:21:33Z"

    }

]

```



#### Snippets list endpoint



For testing the **snippets list** API Rest, please execute the following command:



```bash

$ curl -H 'Accept: application/json; indent=4' -u admin:password123 http://localhost:8000/snippets/list/

[{"id":1,"title":"","code":"foo = \"bar\"\n","linenos":false,"language":"python","style":"friendly"},{"id":2,"title":"","code":"print \"hello, world\"\n","linenos":false,"language":"python","style":"friendly"},{"id":3,"title":"","code":"print \"hello, world\"","linenos":false,"language":"python","style":"friendly"}]

```



#### Snippets detail endpoint



For testing the **snippets detail** API Rest, please execute the following command:



```bash

$ curl -H 'Accept: application/json; indent=4' -u admin:password123 http://localhost:8000/snippets/detail/1/

{"id":1,"title":"","code":"foo = \"bar\"\n","linenos":false,"language":"python","style":"friendly"}

```



## Django Interactive Console

For make some practices the Django ORM, please execute the following command:



```bash

$ python manage.py shell

Python 2.7.13 (default, Nov 24 2017, 17:33:09) 

[GCC 6.3.0 20170516] on linux2

Type "help", "copyright", "credits" or "license" for more information.

(InteractiveConsole)

>>> 

```



At Python Interactive Console, please execute the following command:



```python

>>> 

>>> # Serializers tutorial section

>>> 

>>> # Declaring Serializers section

>>>

>>> from datetime import datetime

>>> 

>>> class Comment(object):

...     def __init__(self, email, content, created=None):

...         self.email = email

...         self.content = content

...         self.created = created or datetime.now()

... 

>>> comment = Comment(email='[email protected]', content='THIS IS A TESTING COMMENT')

>>> comment



>>> from rest_framework import serializers

>>> class CommentSerializer(serializers.Serializer):

...     email = serializers.EmailField()

...     content = serializers.CharField(max_length=200)

...     created = serializers.DateTimeField()

...

>>> 

>>> # Serializing objects section

>>>  

>>> serializer = CommentSerializer(comment)

>>> serializer

CommentSerializer():

    email = EmailField()

    content = CharField(max_length=200)

    created = DateTimeField()

>>> serializer.data

{'email': u'[email protected]', 'content': u'THIS IS A TESTING COMMENT', 'created': '2018-02-03T14:51:39.574410'}

>>> from rest_framework.renderers import JSONRenderer

>>> json = JSONRenderer().render(serializer.data)

>>> json

'{"email":"[email protected]","content":"THIS IS A TESTING COMMENT","created":"2018-02-03T14:51:39.574410"}'

>>> 

>>> # Deserializing objects section

>>> 

>>> from django.utils.six import BytesIO

>>> from rest_framework.parsers import JSONParser

>>> 

>>> stream = BytesIO(json)

>>> data = JSONParser().parse(stream)

>>> data

{u'content': u'THIS IS A TESTING COMMENT', u'email': u'[email protected]', u'created': u'2018-02-03T15:16:41.744807'}

>>>

>>> serializer = CommentSerializer(data=data)

>>> serializer.is_valid()

True

>>> serializer.validated_data

OrderedDict([(u'email', u'[email protected]'), (u'content', u'THIS IS A TESTING COMMENT'), (u'created', datetime.datetime(2018, 2, 3, 14, 51, 39, 574410, tzinfo=))])

>>> 

>>> # Saving instances section

>>> 

>>> class CommentSerializer(serializers.Serializer):

... 

...     email = serializers.EmailField()

...     content = serializers.CharField(max_length=200)

...     created = serializers.DateTimeField()

...     def create(self, validated_data):

...         return Comment(**validated_data)

...     def update(self, instance, validated_data):

...         instance.email = validated_data.get('email', instance.email)

...         instance.content = validated_data.get('content', instance.content)

...         instance.created = validated_data.get('created', instance.created)

...         return instance

... 

>>>

>>> serializer = CommentSerializer(data=data)

>>> serializer = CommentSerializer(comment, data=data)

>>> 

>>> # Validation section

>>> 

>>> serializer = CommentSerializer(data={'email': 'foobar', 'content': 'baz'})

>>> serializer.is_valid()

False

>>> serializer.errors

{'email': [u'Enter a valid email address.'], 'created': [u'This field is required.']}

>>> 

>>> serializer.is_valid(raise_exception=True)

Traceback (most recent call last):

  File "", line 1, in 

  File "/home/leonardo/virtualenv/django27/local/lib/python2.7/site-packages/rest_framework/serializers.py", line 245, in is_valid

    raise ValidationError(self.errors)

ValidationError: {'email': [u'Enter a valid email address.'], 'created': [u'This field is required.']}

>>> 

>>> # Field-level validation section

>>> 

>>> from rest_framework import serializers

>>> class BlogPostSerializer(serializers.Serializer):

...     title = serializers.CharField(max_length=100)

...     content = serializers.CharField()

...     def validate_title(self, value):

...         """

...         Check that the blog post is about Django.

...         """

...         if 'django' not in value.lower():

...             raise serializers.ValidationError("Blog post is not about Django")

...         return value

... 

>>> 

>>> # Object-level validation section

>>>

>>> class EventSerializer(serializers.Serializer):

...     description = serializers.CharField(max_length=100)

...     start = serializers.DateTimeField()

...     finish = serializers.DateTimeField()

...     def validate(self, data):

...         """

...         Check that the start is before the stop.

...         """

...         if data['start'] > data['finish']:

...             raise serializers.ValidationError("finish must occur after start")

...         return data

... 

>>> 

>>> # Validators section

>>>

>>> def multiple_of_ten(value):

...     if value % 10 != 0:

...         raise serializers.ValidationError('Not a multiple of ten')

... 

>>> class GameRecord(serializers.Serializer):

...     score = serializers.IntegerField(validators=[multiple_of_ten])

... 

>>>  

```



# Reference



- [Django 1.9 Project tutorial](https://docs.djangoproject.com/en/1.9/intro/).

- [Django Rest Framework 3.9.1 tutorial Quickstart](http://www.django-rest-framework.org/tutorial/quickstart/).

- [Desarrollo de un API REST con Django REST framework, tutorial 1: Serialización](http://jonathanpumares.com/desarrollo-de-un-api-rest-con-django-rest-framework-tutorial-1-serializacion/).