José Miguel Amaya Camacho

Qué vamos a ver

• 01 Qué es REST y por qué importa 10 min
• 02 Django y Django REST Framework 10 min
• 03 Proyecto, app y configuración 10 min
• 04 Modelos, serializers, vistas y routers 25 min
• 05 Probemos la API y siguientes pasos 5 min

¿Qué es una API REST?

Características de REST (I)

Características de REST (II)

Cliente, métodos y servidor

Métodos y códigos de estado

Ventajas para el desarrollo

¿Qué es Django?

Django en una imagen

Django REST Framework

Una app de Django para construir APIs REST reutilizando piezas, con una API navegable desde el navegador.

¿Por qué no con vistas Django a mano?

Preparar el entorno

Un entorno virtual aísla las dependencias de cada proyecto.

Instalar Django y DRF

Crear el proyecto

Estructura del proyecto

taller/
├── manage.py
├── requirements.txt
└── taller/
    ├── __init__.py
    ├── settings.py
    ├── urls.py
    ├── asgi.py
    └── wsgi.py

Configurar DRF

En taller/settings.py sumamos DRF y nuestra app a las aplicaciones instaladas.

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "rest_framework",
    "cursos",
]

La aplicación cursos

cursos/
├── migrations/
├── admin.py
├── apps.py
├── models.py
├── tests.py
└── views.py

Arrancar el proyecto

El admin y el superusuario

Los modelos

• Descripciónlos datos, en código Python, reflejados en tablas de la base de datos.
• SQL por detráscada consulta ejecuta SQL y devuelve objetos Python cómodos de usar.
• models.pycada aplicación declara ahí sus modelos.

models.py

from django.contrib.auth.models import User
from django.db import models


class Categoria(models.Model):
    nombre = models.CharField(max_length=20)


class Curso(models.Model):
    titulo = models.CharField(max_length=100)
    descripcion = models.TextField(blank=True)
    categorias = models.ManyToManyField(Categoria, related_name="cursos")
    creador = models.ForeignKey(
        User, on_delete=models.CASCADE, null=True, blank=True
    )

    def __str__(self):
        return self.titulo

Los serializadores

Convierten objetos Python ⇄ JSON y validan lo que entra, como los Forms.

serializers.py

from rest_framework import serializers

from cursos.models import Categoria, Curso


class CategoriaSerializer(serializers.ModelSerializer):
    class Meta:
        model = Categoria
        fields = ("id", "nombre")


class CursoSerializer(serializers.ModelSerializer):
    class Meta:
        model = Curso
        fields = ("id", "titulo", "descripcion", "categorias", "creador")

Las vistas

• Entradareciben un objeto con la información de la petición (request).
• Salidadevuelven JSON (u otro formato) o una excepción si algo falla.
• views.pycada aplicación declara ahí sus vistas; en DRF suelen ser clases.

La jerarquía de vistas de DRF

ModelViewSet: las 6 acciones

views.py

from rest_framework import viewsets

from cursos.models import Categoria, Curso
from cursos.serializers import CategoriaSerializer, CursoSerializer


class CategoriaViewSet(viewsets.ModelViewSet):
    queryset = Categoria.objects.all()
    serializer_class = CategoriaSerializer


class CursoViewSet(viewsets.ModelViewSet):
    queryset = Curso.objects.all()
    serializer_class = CursoSerializer

¿Cuánto código necesitas?

El mismo CRUD de Curso, según el enfoque elegido.

Cifras ilustrativas para comparar enfoques; el código real varía según el proyecto.

Los routers

• Definir URLsgeneran las rutas del API de forma ordenada a partir de los ViewSets.
• Mapear verbosdeciden qué acción se ejecuta según el verbo HTTP y el path.
• Organizartodo en el urls.py del proyecto o uno por aplicación.

urls.py

from django.contrib import admin
from django.urls import include, path
from rest_framework import routers

from cursos.views import CategoriaViewSet, CursoViewSet

router = routers.DefaultRouter()
router.register("cursos", CursoViewSet, basename="cursos")
router.register("categorias", CategoriaViewSet, basename="categorias")

urlpatterns = [
    path("admin/", admin.site.urls),
    path("api/v1/", include(router.urls)),
]

El viaje de una petición

Probemos la API

La API navegable permite hacer POST y PUT desde el propio navegador.

También desde la terminal

Errores comunes

Buenas prácticas y siguientes pasos