DRF: Creación de APIs
1. Instalación DRF
DRF (Django Rest Framework)
pip install djangorestframework
2. Serializers
Son componentes que convierten datos complejos en formatos simples y viceversa.
Serialización (Python -> JSON/XML)
- Convierten objetos de Python (como modelos de Django, querysets) en formatos que pueden transmitirse por HTTP
- Por ejemplo: Un objeto
Usuariode la base de datos -> JSON para enviar por la API
Deserialización (JSON/XML -> Python)
- Convierten datos recibidos (JSON, XML) en objetos Python que puedes guardar en la base de datos
- Por ejemplo: JSON recibido en un POST -> Objeto
Usuariovalidado
Ejemplo Serializer
# models.py
class Libro(models.Model):
titulo = models.CharField(max_length=100)
autor = models.CharField(max_length=100)
precio = models.DecimalField(max_digits=6, decimal_places=2)
# serializers.py
class LibroSerializer(serializers.ModelSerializer):
class Meta:
model = Libro
fields = ['id', 'titulo', 'autor', 'precio']
Resultado
{
"id": 1,
"titulo": "Cien años de soledad",
"autor": "Gabriel García Márquez",
"precio": "15.99"
}
3. ViewSets
Son clases de DRF que agrupan toda la lógica para manejar las operaciones CRUD
¿Por qué existen?
Porque escribir vistas separadas para cada operación es repetitivo:
- Vista para listar
- Vista para crear
- Vista para ver detalle
- Vista para actualizar
- Vista para eliminar
Los ViewSets automatizan todo esto
Tipos de Viewsets
| Tipo | Descripción |
|---|---|
| ModelViewSet (el más común) |
|
| ReadOnlyModelViewSet |
|
4. Creación API REST
API que proveerá servicios (datos) mediante endpoints REST
-
Crear nuevo proyecto: Llamado
proyectodrfdjango-admin startproject proyectodrf cd proyectodrf -
Crear App: Llamada
apipython manage.py startapp api -
Configurar Base de datos (1): Crear base de datos
Operations to perform: Apply all migrations: admin, auth, contenttypes, sessions Running migrations: Applying contenttypes.0001_initial... OK Applying auth.0001_initial... OK Applying admin.0001_initial... OK Applying admin.0002_logentry_remove_auto_add... OK Applying admin.0003_logentry_add_action_flag_choices... OK Applying contenttypes.0002_remove_content_type_name... OK Applying auth.0002_alter_permission_name_max_length... OK Applying auth.0003_alter_user_email_max_length... OK Applying auth.0004_alter_user_username_opts... OK Applying auth.0005_alter_user_last_login_null... OK Applying auth.0006_require_contenttypes_0002... OK Applying auth.0007_alter_validators_add_error_messages... OK Applying auth.0008_alter_user_username_max_length... OK Applying auth.0009_alter_user_last_name_max_length... OK Applying auth.0010_alter_group_name_max_length... OK Applying auth.0011_update_proxy_permissions... OK Applying auth.0012_alter_user_first_name_max_length... OK Applying sessions.0001_initial... OKpython manage.py migrate -
Configuración Inicial: Agregar
apiyrest_frameworkensettings.py. Configurar fecha y hora#./proyectodrf/setting.py from pathlib import Path ... ... INSTALLED_APPS = [ ... ... "api", "rest_framework", ] ... ... LANGUAGE_CODE = "es-CL" TIME_ZONE = "America/Santiago" ... ... -
Configuración Modelos: Crear modelo
Proyectoenmodels.py#./api/models.py from django.db import models class Proyecto(models.Model): titulo = models.CharField(max_length=100, null=False, blank=True) descripcion = models.CharField(max_length=200, null=False, blank=True) tecnologia = models.CharField(max_length=100) fecha_creacion = model.DateTimeField(auto_now=True) -
Configurar Base de datos: Crear archivos de migración con los cambios realizados y aplicarlos a la base de datos
Migrations for 'api': api/migrations/0001_initial.py + Create model Proyectopython manage.py makemigrationsOperations to perform: Apply all migrations: admin, api, auth, contenttypes, sessions Running migrations: Applying api.0001_initial... OKpython manage.py migrate -
Configuración Serializers: Crear un nuevo módulo
serializers.py#./api/serializers.py from rest_framework import serializers from .models import Proyecto class ProyectoSerializers(serializers.ModelSerializer): # Permite definir una representación en formato JSON para # nuestra api class Meta: model = Proyecto fields = ['id', 'titulo', 'descripcion', 'tecnologia', 'fecha_creacion'] read_only_fields = ('fecha_creacion',) #tupla -
Configuración ViewSets Crear el módulo
api.pypara los viewsets#./api/api.py from .models import Proyecto from rest_framework import viewsets, permissions from .serializers import ProyectoSerializers # Permite establecer quién y cómo se visualizará # la información de nuestra API class ProyectoViewSet(viewsets.ModelViewSet): # Se define el grupo de datos a disponibilizar queryset = Proyecto.objects.all() # Se definen permisos de acceso permission_classes = [permissions.AllowAny] # Qué serializador se utilizará serializer_class = ProyectoSerializers -
Configurar Enrutamiento: Crear módulo
./api/urls.pyy agregarlo a./proyectoapi/urls.py#./api/urls.py from rest_framework import routers from django.urls import path, include from .api import ProyectoViewSet # Crear rutas CRUD a través de routers router = routers.DefaultRouter() # Registro del path para ejecutar las acciones # GET, POST, PUT, PATCH, DELETE, etc router.register('api/proyectos', ProyectoViewSet, 'proyectos') urlpatterns = [ path("", include(router.urls)), ]#./proyectoapi/urls.py from django.contrib import admin from django.urls import path, include urlpatterns = [ path("admin/", admin.site.urls), path("", include('api.urls')), ] -
Realizar Pruebas: Levantar servidor y verificar ruta
python manage.py runserverhttp://127.0.0.1:8000/Figura 1: Página inicio de nuestra API REST 
Agregar Proyectos
- Crear Datos: Ir a la ruta de la imágen anterior, y agregar proyectos
http://127.0.0.1:8000/api/proyectos/Figura 2: Agregar proyectos a la API 
Figura 3: Proyectos agregados 
5. Consumir API con ThunderClient
- Para consumir la API creada, se utilizará una extensión de VSCode: ThunderClient
- Esta es una forma de probar la API
- En un entorno real, la API sería consumida por una aplicación frontend (React, Vue, etc.) o desde otro backend
-
Iniciar Extensión: Hacer click en botón azul
New RequestFigura 4: Nueva solicitud 
-
Consumir API (1): Solicitar información a la API
GET http://localhost:8000/api/proyectosFigura 5: Solicitar información a la API 
-
Consumir API (2): Enviar información a la API
POST http://localhost:8000/api/proyectosFigura 6: Enviar información a la API 
-
Consumir API (3): Eliminar el proyecto con id=2
DELETE http://localhost:8000/api/proyectos/2/Figura 7: Eliminar información 
-
Consumir API (4): Solicitar nuevamente información a la API
GET http://localhost:8000/api/proyectosFigura 8: Solicitar información a la API (ya no aparece proyecto 2) 
6. Consumir API con proyectoapi
- Se reutiliza el proyecto anterior
proyectoapi, el cual consumía una API de usuarios desde https://reqres.in/api/users?page=2 - Se realizan las siguientes modificaciones a
proyectoapipara que ahora consuma la API de proyectos
-
Consumir API: Crear el método
get_proyectos()en el móduloservice.py#./proyectoapi/api/service.py import requests def get_users(params={}): ... ... def get_proyectos(params={}): try: # Se define el endpoint o URL a consumir url = "http://localhost:8001/api/proyectos" # Consumir la API respuesta = requests.get(url, params=params) #Se realiza check del código de status de HTTP (200) if respuesta.status_code == 200: return respuesta.json() else: return '' except requests.exceptions.RequestExceptions as e: return f"Error: {e}" -
Configurar Vistas: Crear una vista para los proyectos en modulo
views.py#./proyectoapi/api/views.py from django.shortcuts import render from .service import get_users, get_proyectos # Create your views here. ... ... def proyectos(request): params = {} context = { 'proyectos': get_proyectos(params) } return render(request, 'api/proyectos.html', context) -
Configurar Enrutamiento: Agregar ruta para proyectos
#./proyectoapi/api/urls.py from django.urls import path from . import views urlpatterns = [ ... ... path("proyectos/", views.proyectos, name='proyectos'), ] -
Configurar Templates (1): Agregar template
proyectos.html<!-- ./proyectoapi/api/templates/api/proyectos.html --> {% extends "base.html" %} {% block title %} <title>DRF</title> {% endblock title %} {% block content %} <div class="container-fluid p-2 bg-primary text-white text-center"> <h1>Listado de Proyectos desde nuestra API</h1> </div> <div class="container mt-5"> {% if proyectos %} <table class="table"> <thead> <tr> <td>ID</td> <td>Titulo</td> <td>Descripción</td> <td>Tecnología</td> <td>Fecha Creación</td> </tr> </thead> <tbody> {% for p in proyectos %} <tr> <td>{{p.id}}</td> <td>{{p.titulo}}</td> <td>{{p.descripcion}}</td> <td>{{p.tecnologia}}</td> <td>{{p.fecha_creacion}}</td> </tr> {% endfor %} </tbody> </table> {% else %} <p>No se obtiene información del servicio.</p> {% endif %} </div> {% endblock content %} -
Configurar Templates (2): agregar url de proyectos, en navbar de template
base.html<!-- ./proyectoapi/api/templates/base.html --> <!DOCTYPE html> <html lang="en"> {% load static %} <head> ... ... </head> <body> <div class="container-fluid"> <div class="row"> <div class="col-sm-3"> {% block sidebar %} <ul class="sidebar-nav"> <li><a href="{% url 'proyectos' %}">Proyectos</a></li> <li><a href="{% url 'usuarios' %}">Usuarios</a></li> </ul> {% endblock sidebar %} </div> ... ... </div> </div> </body> -
Realizar Pruebas: Levantar ambos proyectos, cada uno en un puerto distinto y realizar pruebas
# Cliente Django que consume la API REST cd proyectoapi python manage.py runserver 8000# Servidor DRF que expone la API cd proyectodrf python manage.py runserver 8001Figura 9: Cliente Django mostrando proyectos desde la API REST 