django api - parte i

¿Cómo hacer un API con Django/Python?

Para realmente entender qué es una API les recomendamos primero leer este otro post: ¿Qué es un API?.

En resumen, una API proporciona diferentes URLs (el término correcto es endpoints) para hacer consultas a la Base de Datos de una aplicación e incluso transformar la data antes de devolverla a la aplicación que está solicitándo esta información. E incluso accediendo a un endpoint puedes eliminar la registros o completamente la base de datos asociada a un API.

La estructura de las urls para acceder a los diferentes servicios de la API las define la persona o personas que desarrollan la API y deben documentarla para que otros programadores puedan acceder a ellas desde sus aplicaciones.

Gráfico con diferentes endpoints y cómo pueden obtener información (GET), ingresar información (POST), borrar información (DELETE), actualizar información (PATCH)

Para hacer un API vamos a necesitar las siguientes librerías:

pip install djangorestframework
pip install markdown       # Markdown support for the browsable API.
pip install django-filter  # Filtering support

Luego vas a tener que agregar 'rest_framework' a tus aplicaciones instaladas en INSTALLED_APPS setting.

INSTALLED_APPS = (
    ...
    'rest_framework',
)

Y si quieres usar la API desde tu navegador web vas a tener implementar las vistas de login y logout de REST framework.

urlpatterns = [
    ...
    url(r'^api-auth/', include('rest_framework.urls'))
]

Si necesitan, pueden ver todos los detalles de cómo implementar una API desde la página oficial Django REST framework.

Serializers: ¿qué es un serializer?

Entender qué es un serializer es clave si deseas trabajar con APIs.

En resumen lo que hace un serializer es transformar el QuerySet (la consulta en Python que se hace a la base de datos) a formato JSON o XML (formatos estándar para comunicación entre aplicaciones web).

Como les comentamos en un post anterior, la idea detrás de desarrollar un API es poder comunicar una aplicación escrita en el lenguaje X, con muchas otras escritas en el mismo lenguaje u en otros muy distintos; esto a través de endpoints (que basicamente son urls específicas según la tarea que se quiera desarrollar - ej. my-pet-api/customers para crear, borrar o actualizar clientes, etc.)

Sin embargo, en programación no existe un lenguaje universal para desarrollar y utilizar aplicaciones. Existen muchos lenguajes de programación como R, Python, Ruby, etc.

Lo que sí existen son formatos estándar para transmitir información entre aplicaciones en la web: XML, JSON, YALM, entre otros. No importa en qué lenguaje se desarrolle la API, el objetivo es que el output que genere esté en alguno de los formatos antes mencionados para que esta información puede ser consumida y transformada en cualquier otra aplicación. Ej. Una API desarrollada en Django/Python devuelve data en formato JSON, que puede ser consumida por una aplicación desarrollada en Java, que lo que finalmente hace es mostrarle un gráfico de barras a sus usuarios (en base a la información que obtuvo del API).

En resumen: un serializer lo que hace es transformar la respuesta de nuestra aplicación en un formato estándar para que otras aplicaciones puedan hacer eso de esta data. Un serializer transforma la data obtenida por un QuerySet en formato JSON o XML.

En el siguiente gráfico se aprecia como el serializer transforma la data y la devuelve al ViewSet quien es el responsable final de responder la consulta que hicieron a nuestra API al ingresar la URL: /customer/1.

from django.db import models

class DataSheet(models.Model):
    description = models.CharField(max_length=50)
    historical_data = models.TextField()

from rest_framework import serializers
from .models import DataSheet

class DataSheetSerializer(serializers.ModelSerializer):
    class Meta:
        model = DataSheet
        fields = ('id', 'description', 'historical_data')

from .serializers import *

class DataSheetViewSet(viewsets.ModelViewSet):
    queryset = DataSheet.objects.all()
    serializer_class = DataSheetSerializer
    

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

router = routers.DefaultRouter()
router.register(r'customers', CustomerViewSet)
router.register(r'professions', ProfessionViewSet)
router.register(r'data-sheet', DataSheetViewSet)
router.register(r'document', DocumentViewSet)

urlpatterns = [
    path('api/', include(router.urls)),
    path('api-auth/', include('rest_framework.urls')),
    path('admin/', admin.site.urls),
]

python manage.py makemigrations
python manage.py migrate
python manage.py runserver 8004 # o cualquier otro puerto que elijas