Creación de un proyecto Django Rest API

Introducción

Introducción a Django Rest Framework (DRF)

Django Rest Framework (DRF) es un framework que facilita la creación rápida de APIs RESTful utilizando Django, un popular framework de desarrollo web en Python. DRF ofrece un conjunto de herramientas y funcionalidades diseñadas para hacer la creación de APIs más fácil y eficiente. Utilizando la arquitectura REST, se pueden crear aplicaciones web que son escalables y flexibles.

Pasos para Crear una API con Django Rest Framework:

Creación de un Nuevo Proyecto de Django: El primer paso es crear un nuevo proyecto de Django. Esto establece la base para el desarrollo de la API.
Instalación y Configuración de Django Rest Framework: Una vez creado el proyecto, es necesario instalar Django Rest Framework y configurarlo en el archivo "settings.py" del proyecto.
Creación de una Nueva Aplicación de Django: Se debe crear una nueva aplicación dentro del proyecto que manejará la lógica de la API.
Definición de Modelos: La creación de modelos en la aplicación es crucial, ya que definen la estructura de los datos que serán almacenados y mostrados en la API.
Creación de Serializadores: Los serializadores son responsables de transformar los objetos Python en JSON y viceversa, facilitando la interacción entre el backend y el frontend.
Definición de Vistas de la API: Finalmente, se deben definir las vistas de la API. Esto se realiza utilizando clases de vista proporcionadas por Django Rest Framework, que simplifican la gestión de solicitudes HTTP y la entrega de respuestas.

Crear una API con Django Rest Framework es un proceso sencillo y directo que puede implementarse en poco tiempo. Este enfoque permite la creación de aplicaciones web que son tanto escalables como flexibles, adaptándose a las necesidades de los desarrolladores y de la industria.

Resumen

Para crear un proyecto de Django Rest API, sigue los siguientes pasos:

Abre una terminal y asegúrate de tener instalado Django y Django Rest Framework.
```
pip install django
pip install djangorestframework
```
Crea un nuevo proyecto de Django.
```
django-admin startproject myproject
```
Ingresa al directorio de tu proyecto.
```
cd myproject
```
Crea una nueva aplicación Django.
```
python manage.py startapp myapp
```

Agrega 'rest_framework' a la lista de aplicaciones instaladas en settings.py.

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',  # agrega esta línea
    'myapp',            # agrega aquí el nombre de tu aplicación
]

Crea un archivo serializers.py dentro de tu aplicación.

from rest_framework import serializers
from .models import MyModel

class MyModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = MyModel
        fields = '__all__'

Crea una vista para manejar las solicitudes en tu archivo views.py.

from rest_framework.views import APIView
from rest_framework.response import Response
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelView(APIView):
    def get(self, request, pk=None):
        if pk:
            mymodel = MyModel.objects.get(pk=pk)
            serializer = MyModelSerializer(mymodel)
            return Response(serializer.data)
        else:
            mymodels = MyModel.objects.all()
            serializer = MyModelSerializer(mymodels, many=True)
            return Response(serializer.data)

Agrega tus URLs.

from django.urls import path
from .views import MyModelView

urlpatterns = [
    path('mymodel/', MyModelView.as_view()),
    path('mymodel/', MyModelView.as_view()),
]

Ejecuta tu servidor de desarrollo.
```
python manage.py runserver
```
Ahora, puedes realizar solicitudes a tu API a través de tu navegador o una herramienta como Postman.

Aplicación teórica

Creación de un proyecto Django Rest API

Aquí te presento un ejemplo práctico para la creación de un proyecto Django Rest API:

Lo primero que debes hacer es crear un nuevo entorno virtual de Python y activarlo.
A continuación, instala Django y Django Rest Framework mediante los comandos:
```
pip install django
pip install djangorestframework
```
Después de instalar ambas bibliotecas, crea tu proyecto Django API escribiendo:
```
django-admin startproject nombre_proyecto
```
Ahora, crea una aplicación dentro del proyecto Django API ingresando en la terminal:
```
python manage.py startapp nombre_aplicacion
```
En el archivo urls.py del proyecto, agrega la ruta a la aplicación que acabas de crear utilizando la función include de Django:
```
from django.urls import path, include
urlpatterns = [
    path('nombre_aplicacion/', include('nombre_aplicacion.urls')),
]
```
En el archivo models.py de la aplicación, define el modelo que deseas utilizar en tu API.

En el archivo serializers.py de la aplicación, define un serializador para el modelo que acabas de crear. El serializador determina cómo se serializa y deserializa el modelo en formato JSON:

from rest_framework import serializers
from .models import NombreModelo

class NombreModeloSerializer(serializers.ModelSerializer):
    class Meta:
        model = NombreModelo
        fields = '__all__'

En el archivo views.py de la aplicación, crea la vista para la API utilizando los serializadores definidos anteriormente:

from rest_framework import generics
from .models import NombreModelo
from .serializers import NombreModeloSerializer

class NombreModeloList(generics.ListCreateAPIView):
    queryset = NombreModelo.objects.all()
    serializer_class = NombreModeloSerializer

class NombreModeloDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = NombreModelo.objects.all()
    serializer_class = NombreModeloSerializer

Define las URL para tu API en el archivo urls.py de la aplicación:

from django.urls import path
from .views import NombreModeloList, NombreModeloDetail
urlpatterns = [
    path('nombre_modelo/', NombreModeloList.as_view()),
    path('nombre_modelo/', NombreModeloDetail.as_view()),
]

Ejecuta python manage.py migrate para migrar la base de datos.
Finalmente, ejecuta python manage.py runserver para ejecutar tu API y comenzar a probar las rutas que has creado. Por ejemplo, al ingresar a http://localhost:8000/nombre_aplicacion/nombre_modelo/ en tu navegador, deberías obtener una lista de objetos JSON correspondientes a tu modelo.

Aplicación práctica

Ejemplo práctico de cómo crear un proyecto Django Rest API

Primero, debes asegurarte de tener Django y Django Rest Framework instalados. A continuación, sigue estos pasos:

Crea un nuevo proyecto de Django usando el comando:
```
django-admin startproject myapi
```
Crea una nueva aplicación dentro del proyecto usando el comando:
```
python manage.py startapp api
```

Agrega la aplicación rest_framework y la aplicación api a la lista INSTALLED_APPS dentro del archivo settings.py:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',
    'api',
]

Define tus modelos dentro de la aplicación api en el archivo models.py:

from django.db import models

# Ejemplo de modelo
class Producto(models.Model):
    nombre = models.CharField(max_length=255)
    descripcion = models.TextField()
    precio = models.DecimalField(max_digits=6, decimal_places=2)

Crea un serializador en el archivo serializers.py para transformar los modelos a JSON:

from rest_framework import serializers
from .models import Producto

# Ejemplo de serializador
class ProductoSerializer(serializers.ModelSerializer):
    class Meta:
        model = Producto
        fields = ('id', 'nombre', 'descripcion', 'precio')

Crea una vista en el archivo views.py para procesar las solicitudes HTTP:

from rest_framework import generics
from .models import Producto
from .serializers import ProductoSerializer

# Ejemplo de vista
class ProductoList(generics.ListCreateAPIView):
    queryset = Producto.objects.all()
    serializer_class = ProductoSerializer

Agrega la URL de la vista a las rutas del proyecto en el archivo urls.py:

from django.urls import path, include
from rest_framework import routers
from api.views import ProductoList

router = routers.DefaultRouter()
router.register(r'productos', ProductoList)

urlpatterns = [
    path('', include(router.urls)),
]

¡Listo! Ahora puedes ejecutar el servidor de Django usando el comando python manage.py runserver y probar tu API en el navegador o utilizando alguna herramienta de pruebas de APIs, como Postman. En este caso, podrías consultar los productos creados en la base de datos con la URL http://localhost:8000/productos/.