03 - API - Pasos para crear una API usando Python/Django

Iniciado por Mr. Bones, Septiembre 11, 2023, 11:50:20 AM

Tema anterior - Siguiente tema

0 Miembros y 1 Visitante están viendo este tema.

Septiembre 11, 2023, 11:50:20 AM Ultima modificación: Septiembre 11, 2023, 04:36:19 PM por Mr. Bones
Pasos para crear una API Rest

A continuación, te proporcionaré una guía paso a paso para crear una API de prueba simple utilizando Django Rest Framework (DRF), que es una potente biblioteca para crear APIs RESTful en Django.



Paso 1: Configuración del entorno Asegúrate de tener Python instalado en tu sistema. Luego, puedes crear un entorno virtual para tu proyecto:

Código: text
python -m venv myenv

Activa el entorno virtual:

•    En Windows:

Código: text
myenv\Scripts\activate

•    En macOS y Linux:
 

Código: text
source myenv/bin/activate

Paso 2: Instala Django y Django Rest Framework Dentro del entorno virtual, instala Django y Django Rest Framework:

Código: text
pip install django
pip install djangorestframework

Paso 3: Crea un nuevo proyecto Django Crea un nuevo proyecto Django:

Código: text
django-admin startproject projectname

Reemplaza projectname con el nombre de tu proyecto.

Paso 4: Crea una aplicación Dentro del proyecto, crea una nueva aplicación:

Código: text
cd projectname python manage.py startapp myapp

Paso 5: Configura la aplicación en tu proyecto Agrega la aplicación recién creada al archivo You are not allowed to view links. You are not allowed to view links. Register or Login or You are not allowed to view links. Register or Login de tu proyecto:

Código: text
INSTALLED_APPS = 
[ # ...
'myapp',
'rest_framework', 
]

Paso 6: Define un modelo En el archivo You are not allowed to view links. You are not allowed to view links. Register or Login or You are not allowed to view links. Register or Login de tu aplicación, define un modelo que represente los datos que deseas exponer a través de la API. Por ejemplo:

Código: text
from django.db import models
 
    class Item(models.Model): 
    name = models.CharField(max_length=100) 
    description = models.TextField() 
    def __str__(self): 
    return self.name 

Paso 7: Crea migraciones y aplica los cambios a la base de datos Ejecuta los siguientes comandos para crear migraciones y aplicar los cambios a la base de datos:

Código: text
python manage.py makemigrations 
python manage.py migrate


Paso 8: Crea un serializador En tu aplicación, crea un archivo You are not allowed to view links. You are not allowed to view links. Register or Login or You are not allowed to view links. Register or Login y define un serializador para el modelo Item:

Código: text
from rest_framework import serializers
from .models import Item

class ItemSerializer(serializers.ModelSerializer):
   class Meta: model = Item 
   fields = '__all__'

Paso 9: Crea vistas y rutas (URLs) En tu aplicación, crea un archivo You are not allowed to view links. You are not allowed to view links. Register or Login or You are not allowed to view links. Register or Login y define una vista utilizando DRF:

Código: text
from rest_framework import generics
from .models import Item
from .serializers import ItemSerializer 

class ItemList(generics.ListCreateAPIView): 
    queryset = Item.objects.all() 
    serializer_class = ItemSerializer

Luego, configura las rutas (URLs) en el archivo You are not allowed to view links. You are not allowed to view links. Register or Login or You are not allowed to view links. Register or Login de tu aplicación:

Código: text
from django.urls import path
from .views import ItemList 
urlpatterns = [ 
        path('items/', ItemList.as_view(), name='item-list'), 
]

Paso 10: Ejecuta el servidor de desarrollo Inicia el servidor de desarrollo de Django para probar tu API:

Código: text
python manage.py runserver

Ahora puedes acceder a tu API en You are not allowed to view links. You are not allowed to view links. Register or Login or You are not allowed to view links. Register or Login. Puedes usar herramientas como curl, httpie, o un navegador web para realizar solicitudes a la API y probar su funcionalidad.
Este es un ejemplo simple de cómo crear una API de prueba con Python y Django utilizando el Django Rest Framework. Puedes agregar más modelos, vistas y funcionalidades según tus necesidades específicas.
Mr. Bones

You are not allowed to view links. You are not allowed to view links. Register or Login or You are not allowed to view links. Register or Login

Recuerda utilizar las etiquetas apropiadas, eso facilita la lectura.

Por ejemplo, en vez de usar [b] puedes usar [code].

~ DtxdF
PGP :: <D82F366940155CB043147178C4E075FC4403BDDC>

~ DtxdF