CursosEmpresasBlogLiveConfPrecios

Contenido del curso

Tomar examen

Códigos de estado HTTP en FastAPI

Resumen

¿Cómo se implementan los códigos de estado HTTP en FastAPI?

Los códigos de estado HTTP son esenciales para comprender la respuesta de un servidor ante una solicitud. En FastAPI, estos códigos permiten indicar el éxito o el error de las peticiones realizadas en una aplicación web. Descubre cómo puedes incorporarlos efectivamente en tus proyectos y mejorar tu API con respuestas más claras y efectivas.

¿Qué son los códigos de estado HTTP y cuáles existen?

Los códigos de estado HTTP se dividen en categorías que representan diferentes tipos de respuestas por parte del servidor:

  • Códigos informativos (100-199): Indican que se está procesando una solicitud.
  • Códigos de éxito (200-299): Señalan que la solicitud se ha procesado correctamente.
  • Códigos de redirección (300-399): Indican que se necesita una acción adicional por parte del cliente.
  • Códigos de error del cliente (400-499): Representan errores que ocurren debido a solicitaciones mal formadas por parte del cliente.
  • Códigos de error del servidor (500-599): Indican que el servidor ha encontrado una situación que le impide procesar la solicitud.

Ejemplos de códigos de respuesta comunes:

  • 200 OK: La solicitud se gestionó correctamente.
  • 201 Created: Un nuevo recurso ha sido creado con éxito.
  • 400 Bad Request: La solicitud no fue procesada debido a un error del cliente.
  • 404 Not Found: El recurso solicitado no se encuentra en el servidor.
  • 500 Internal Server Error: Un error general del servidor.

¿Cómo implementar códigos de estado en FastAPI?

Implementar estos códigos en FastAPI es un proceso sencillo. Para cada ruta, puedes especificar un código de estado dentro de los métodos HTTP (como GET o POST) utilizando el parámetro status_code.

from fastapi import FastAPI, HTTPException

app = FastAPI()

@app.get("/peliculas", status_code=200)
async def obtener_peliculas():
    # Lógica para obtener películas
    return {"peliculas": [...]}

@app.post("/peliculas", status_code=201)
async def crear_pelicula():
    # Lógica para crear una nueva película
    return {"mensaje": "Película creada"}

@app.get("/peliculas/{id}", status_code=404)
async def obtener_pelicula_por_id(id: int):
    # Supongamos una búsqueda que podría no encontrar la película
    raise HTTPException(status_code=404, detail="Película no encontrada")

¿Cómo se determina el código de estado adecuado?

Al elegir qué código de estado implementar, es fundamental considerar la intención y el resultado esperado de la petición. Por ejemplo, al leer o eliminar datos exitosamente, usarías un 200 OK. Si estás creando algo nuevo, un 201 Created es más adecuado. En casos de error, un 404 Not Found o 400 Bad Request puede informar al cliente de manera efectiva.

¿Cómo probar el comportamiento de los códigos HTTP en FastAPI?

Puedes probar el comportamiento de tu API directamente recargando su documentación integrada. FastAPI genera documentación automáticamente usando Swagger, donde puedes:

  1. Acceder a http://localhost:8000/docs.
  2. Probar diferentes solicitudes HTTP y observar el código de estado resultante junto con el mensaje de detalle.
  3. Optimizar tus respuestas basándote en los escenarios de uso común y los resultados obtenidos.

¿Cómo gestionar errores personalizados?

FastAPI permite no solo devolver códigos de estado, sino también personalizar mensajes de error para proporcionar información más detallada al cliente. Utiliza HTTPException para lanzar errores con detalles específicos.

from fastapi import HTTPException

@app.get("/buscar/{item_id}", status_code=404)
async def buscar_item(item_id: int):
    # Si no se encuentra el ítem, lanzar un error
    raise HTTPException(status_code=404, detail=f"Item {item_id} no encontrado")

Integrar y gestionar correctamente los códigos de estado en tu aplicación FastAPI no solo mejora la claridad de las respuestas de tu API, sino que también facilitan la interacción con los clientes al proporcionar información precisa sobre el resultado de sus solicitudes. Sigue explorando y aplicando estas prácticas para convertirte en un experto en FastAPI. ¡Continúa aprendiendo y perfeccionando tus habilidades!