Introducción #

Django es un framework que permite realizar aplicaciones web de una manera sencilla y rápida.

A esto hay que sumarle Django Rest Framework, de aquí en adelante DRF, que permite crear servicios REST a través de Django

En mi caso quiero usar Django + Django Rest Framework porque me permite publicar servicios web y guardar determinada información en una base de datos (inicialmente estoy usando la que viene por defecto que es SQLite3) de una manera bastante sencilla. Ya que usando las vistas de tipo ViewSet DRF se encarga de gestionar todo el CRUD de un modelo de datos sin añadir nada de código. Además DRF usa la arquitectura MVC. Donde la M son los modelos que se crean en Django. La V son las Views de DRF. Y la C es el serializer de DRF. Esto hace posible crear servicios sin modelo usando solo las Views y Serializers con DRF. Que no sé si esto con Django se puede hacer.

A nivel de usarlo en nuestras aplicaciones Django se estructura en proyectos y aplicaciones. Y estos se creán dentro del directorio de nuestro proyecto.

Muchos pasos hay que realizarlos desde el terminal de Windows. Que se puede usar tanto el Anaconda PowerShell como el VSCode si lo hemos abiertos a través del Anaconda Navigator con el entorno que queremos ya preseleccionado. El resultado en ambos casos es el mismo

Instalar las librerías #

Django se puede instalar a través de Anaconda:

Libreria Django Rest Framework

Django Rest Framework hay que instalarlo a través del PiP:

conda activate <entorno>
pip install djangorestframework

Creación del proyecto #

Desde el terminal, yo he usado el del VSCode con lo cual lo primero que he hecho es:

conda activate <entorno>

Aunque tecnicamente estaba en el entorno, ya que lo habia abierto desde el Anaconda, con esto me curo en salud.

IMPORTANTE: Los siguientes pasos hay que hacerlos estando en el directorio de la aplicación. Como he usado el VSCode ya estaba en dicho directorio

Ahora se crea el proyecto:

D:\Users\ivan\anaconda3\envs\ocr\Lib\site-packages\django\bin\django-admin.py startproject rest_api # Importante hay que poner la ruta completa donde esta el django-admin.py

AVISO: Como estaba en el directorio de la aplicación he tenido que poner la ruta completa donde esta el script: djando-admin.py

El nombre del proyecto es rest_api. Con esto nos ha creado un directorio rest_api y a su vez dentro habrá otro directorio con el mismo nombre al cual tenemos que acceder para:

Modificar el fichero settings.py que se tiene que modificar:

Localizar la variable INSTALLED_APPS y añadir el valor ‘rest_framework’ –> Esto nos permite usar la librería para crear servicios Rest
Localizar la variable LANGUAGE_CODE y cambiar el valor por ‘es-es’
Localizar la variable TIME_ZONE y cambiar el valor por Europe/Berlin

Vamos a crear la base de datos inicial. Para ellos hay que volver al directorio del proyecto creado rest_api y lanzar el comando

manage.py migrate

El fichero manage.py se va utilizar para muchos procesos.

Django a cualquier operación de replicar lo que hagamos en los archivos de los modelos lo llama migración.

Arrancar el servidor #

Para arrancar el servidor hay que estar en el directorio del proyecto rest_api y lanzar el siguiente comando

manage.py runserver

Si accedemos a esta http://localhost:8000/ o http://127.0.0.1:8000/ veremos si todo ha ido bien.

La ventana que nos abra con el proceso corriendo no la podemos cerrar ya que sino no funcionara ninguna llamada.

Panel de administración #

Lo bueno de Django es que viene con un panel de control para gestionar usuarios, grupos y modelos. Pero primero hay que generar un superusuario. Para ello desde el directorio del proyecto y ejecutar el siguiente script:

manage.py createsuperuser

Nos pedirá nombre de usuario, mail y password. Para acceder al panel tan solo hay que acceder a http://localhost:8000/admin/

Crear aplicación #

Será la aplicación donde se crearán los modelos y servicios. Para ellos desde el directorio del proyecto hay que lanzar el siguiente script:

manage.py startapp image

Donde image es el nombre de nuestra aplicación.

Para que poder usar la aplicación hay que registrarlo en el fichero settings.py de nuestro proyecto y editarlo. En el fichero hay que localizar la variable INSTALLED_APPS y añadir el valor ‘image.apps.ImageConfig’. Donde image es el directorio que ha creado el proyecto, apps es el fichero apps.py y ImageConfig es el nombre del clase dentro del fichero apps.py.

Com replicar los modelos en la base de datos #

Como crear modelos hay multitidud de manuales y guias explicandolos. Pero aquí explicamos los pasos para sincronizarlos con la base de datos:

import uuid
from django.db import models


class Image(models.Model):
    id = models.UUIDField(auto_created=True, primary_key=True, default=uuid.uuid4,
                          editable=False)
    content = models.BinaryField()
    filename = models.TextField(max_length=100, default='')

Una vez creando el modelo hay que lanzar dos script para que sincronicen con nuestro base de datos:

Crear una foto de los cambios en los modelos de la aplicación

manage.py makemigrations image

La fotos de los cambios replicarlos a la base de datos:

manage.py migrate

Si queremos borrar un modelo tan solo hay que borrarlo del fichero models.py y realizar los dos pasos anteriores para sincronizarlos.

Como administrar los modelos creados #

Si accede a la página de administración los modelos no aparecen automáticamente, se tienen que registrar. Para ello hay que ir al directorio donde esta la aplicación y editar el fichero admin.py y añadir la siguiente línea, o líneas según modelos creados:

admin.site.register(Image)

Donde Image es el nombre del modelo(es una clase) que esta definida en el archivo models.py del mismo directorio.

Artículos sobre Django #

Autentificación por sesión: Autentificación por sesión
Como utilizar React como frontend: Como utilizar React como frontend
Configuración URLs aplicación: Configuración URLs aplicación
Equivalencia métodos HTTP y DRF: Equivalencia métodos HTTP y Djando Rest Framework
Incluir librerías propias: Incluir librerías propias
Permitir CORS: Permitir CORS
Queries en modelo de datos: Queries en modelo de datos
Servicios con ficheros: Envio, recepción y borrado de ficheros