Entendiendo Django Rest Framework

¿Porqué Django?

A estas alturas, como desarrollador, probablemente te hayas dado cuenta de la importancia de las librerías de terceros para ayudarte a ti mismo a través de la programación. El 99.99% de todo lo que estás a punto de codificar ya ha sido construido. Existe una herramienta para todo y, como desarrolladores, nuestro trabajo es seleccionarlas con inteligencia e integrarlas de manera coherente para resolver un problema en particular.

Django es LA HERRAMIENTA para el desarrollo web. No es solo una librería - son docenas de librerías agrupadas. Es una serie de "mejores prácticas" y formas eficientes de trabajar. Estas son algunas de las características más sorprendentes:

• Viene con un servidor de desarrollo (configuración mínima) que te permite comenzar a codificar de inmediato.
• Tiene una interfaz de línea de comandos (manage.py) que acelera el proceso de desarrollo.
• Documentación y comunidad: la comunidad de django es tan grande que no tendrás problemas para encontrar respuestas, tutoriales, etc.

La Arquitectura de Django

Al igual que cualquier otro marco, Django propone una arquitectura específica para construir tu software y tenemos que aprender, adoptar y dominar todo esto si queremos convertirnos en Desarrolladores Senior Full Stack (usando Django):

El primer concepto a aprender es la diferencia entre sitio web v/s App. Un buen Ejemplo puede ser BreatheCo.de

BreatheCode es un gran sitio web de django con varias aplicaciones dentro:

• admin.breatheco.de: Este es el portal de administración donde se gestionan todos los alumnos, cursos y ubicaciones.
• breatheco.de: Este es el acceso de los estudiantes a los cursos.
• assets.breatheco.de: Esta es una útil compilación de herramientas tanto para el profesor como para los estudiantes.

Todas esas aplicaciones pueden ser parte de un gran sitio web llamado "Plataforma BreatheCode".

Creando un Nuevo Projecto

para comenzar un proyecto todo lo que debes hacer es:

1$ django-admin startproject [project_name]
2$ cd [project_name]

Eso creará una nueva carpeta en su directorio actual con el nombre del proyecto y una serie de archivos.

¡No tengas miedo de los archivos generados!

¡Recuerda que todo es texto! Puedes y debes jugar con los archivos generados para entenderlos correctamente. ¡No tengas miedo! Lo peor es que tengas que ejecutar el comando createproject nuevamente 🙂

Después de ejecutar el comando, se creará una carpeta de proyecto con al menos 4 archivos dentro:

• __init__: un archivo vacío que cualquier carpeta debe tener dentro para ser considerado un paquete de python.
• settings: contiene todas las variables de configuración para su proyecto - más adelante hablaremos más sobre este archivo.
• urls: contiene todas las rutas URL de su sitio web, la ruta / admin se agrega de forma predeterminada a todos los proyectos de Django.
• wsgi: Contiene la lógica para el servidor Django.

El archivo manage.py que está afuera es una herramienta CLI para poder controlar y usar Django desde la línea de comandos. Lo usarás a diario.

Creando la Primera Aplicación

Ahora que tenemos un gran proyecto (sitio web) es hora de comenzar a agregarle aplicaciones. Para crear tu primera aplicación Django, escribe el siguiente comando:

1$ python manage.py startapp [app_name]

☝️ Para ejecutar este comando, debes estar parado en la misma carpeta que el archivo manage.py. Puede usar el comando CD para moverse a esa misma carpeta.

Una vez más, ¡no le tengas miedo de los archivos generados!

Verás una nueva carpeta con el nombre de tu aplicación y muchos archivos dentro. Revisémoslos:

• __init__: Le dice a Python que esta carpeta es un paquete.
• admin.py: Aquí podemos agregar modelos en la interfaz de administración para poder CRUD esos modelos.
• models.py: Aquí tendremos que definir nuestro modelo de base de datos (todas las estructuras de objetos que queremos almacenar en una base de datos).
• apps.py: No toques esto - describe qué aplicaciones que tenemos.
• tests.py: Aquí puedes escribir tu aplicación unit tests.
• views.py: Aquí tienes que describir cómo se construirán sus archivos HTML o JSON.

Vamos a discutir todos estos archivos más detalladamente a continuación.

Para resumir y continuar con nuestro ejemplo del "Proyecto BreatheCode", esta es la forma en que la estructura de archivos de su proyecto puede verse después de tener varias aplicaciones dentro de un gran proyecto.

Manage.py (Django CLI)

El archivo Manage.py es una increíble herramienta de línea de comando que te ayudará mucho. No solo es útil para crear nuevas aplicaciones dentro de tu proyecto, sino para todas estas otras tareas (y más):

Crea usuarios administradores para tus aplicaciones.	$ python manage.py createsuperuser
Ejecutando el servidor de desarrollo de Python	$ python manage.py runserver $IP:$PORT
Haciendo migraciones	$ python manage.py makemigrations [your_appliation_name]
Ejecutando migraciones	$ python manage.py migrate

Arquitectura de Django para construir API RESTful

Vamos a construir una API basada en REST, pero no tengas miedo del nombre - el estándar REST básicamente se construyó como una API extremadamente simple.

☝️ 📺 Puedes leer más sobre las API REST en esta lección de BreatheCode.

Aquí hay un video divertido de 8 minutos que explica REST: https://www.youtube.com/watch?v=7YcW25PHnAA

Así es cómo Django maneja cualquier solicitud HTTP de API:

• La primera parte del código que trata con la Solicitud será el Distribuidor de URL (urls.py). Su objetivo principal es comprender qué APIView correspondiente debe instanciarse en función de la URL que se llamó y, finalmente, llamar al método GET, POST, PUT o DELETE de esa APIView según el tipo de solicitud.

• Como segundo paso, APIView recibe los parámetros de la URL (si los hay) a través de los parámetros del método y luego ejecuta cualquier lógica codificada para procesar la solicitud o las interacciones del modelo de la base de datos. Por ejemplo: Obteniendo alguna información de la base de datos; guardando o borrando alguna otra información; enviando correos electrónicos etc.

• El siguiente paso, debe ser decidir qué JSON debe retornarse dentro del "Body" de la Respuesta. Para eso tenemos el "serializer".

• Finalmente, APIView debe retornar un objeto de respuesta que contenga el objeto JSON preparado por el serializer.

urls.py: El Distribuidor de URL

1from django.urls import include, path
2from . import views
3
4urlpatterns = [
5    path('games/', views.GamesView.as_view(), name='games'),
6    path('game/', views.GameView.as_view(), name='game'),
7    ...
8]

El archivo urls.py contiene un array PATHs. Cada ruta comienza con un patrón de URL seguido de la VISTA que se supone que administra esa ruta y 2 parámetros opcionales: NOMBRE: para identificar la ruta; y KWARGS: una lista de valores que se pueden pasar a VIEW.

view.py: Lógica de renderizado

1class GamesView(APIView):
2    def get(self, request):
3        games = Game.objects.all()
4        serializer = GameSerializer(games, many=True)
5        return Response(serializer.data)
6    def post(self, request, game_id):
7         # any logic for the post request
8        pass

Las "vistas" se denominan "vistas" porque su principal responsabilidad es generar la respuesta que se enviará a quien lo solicite. Por ejemplo: retornar un JSON o un documento HTML.

Pero las vistas tienen otra responsabilidad: las vistas deben ocuparse de cualquier lógica necesaria antes de enviar la respuesta. Por ejemplo, si la solicitud entrante era una solicitud POST para actualizar a un usuario, entonces la vista debe interactuar primero con la Base de datos y actualizar PRIMERO al usuario; luego puede continuar y devolver al usuario actualizado como un objeto JSON.

El ejemplo de la izquierda es una vista que atenderá dos posibles solicitudes: el GET y el POST para la URL /game. Para el GET, GamesView obtendrá todos los objetos del juego de la base de datos y retornará un JSON con la lista de ellos; para el POST, GamesView no tiene ninguna lógica todavía, pero debe buscar el juego en particular con ese game_id dado y actualizarlo.

models.py: Modelos de Base de Datos

1from django.db import models
2
3# Create your models here.
4class Game(models.Model):
5    player1 = models.CharField(max_length=20)
6    player2 = models.CharField(max_length=20)
7    winner = models.CharField(max_length=20)

Models.py es el lugar donde defines todos los objetos que se guardarán en la base de datos y toda la lógica necesaria para interactuar con ellos. También debes especificar el tipo de datos para cada una de las propiedades que tiene cada objeto.

El ejemplo que hemos estado usando solo necesita Game Class como modelo, y Game Class tiene sólo 3 propiedades.

tests.py: Pruebas de la Aplicación

1from django.urls import include, path
2from . import views
3
4urlpatterns = [
5    path('games/', views.GamesView.as_view(), name='games'),
6    path('game/', views.GameView.as_view(), name='game'),
7    ...
8]

El archivo urls.py contiene un array PATHs. Cada ruta comienza con un patrón URL, seguido de la VISTA que se supone que administra esa ruta y 2 parámetros opcionales: NOMBRE: Para identificar la ruta; y KWARGS: una lista de valores que se pueden pasar al VIEW.

📺 Aquí hay una serie de 5 videos que explican las APIs de django de una manera sorprendente: https://www.youtube.com/watch?v=Yw7gETuRKjw&index=37&list=PL6gx4Cwl9DGBlmzzFcLgDhKTTfNLfX1IK

🔗 Este sitio web contiene sorprendentes recursos de Django: http://awesome-django.com