tutorial fastapi - seis avanzados (Código de estado de respuesta)

Contenido de referencia :

• https://fastapi.tiangolo.com/

En el tutorial fastapi - advanced five (Response Model), aprendimos cómo controlar la estructura del cuerpo de la respuesta. En esta sección, aprenderemos cómo usar el código de estado http:

from fastapi import FastAPI

app = FastAPI()


@app.post("/items/", status_code=201)
async def create_item(name: str):
    return {
    
    "name": name}

Inicie el servicio, ábralo http://127.0.0.1:8000/docs, echemos un vistazo a la respuesta:

Este ejemplo status_codedefine el código de estado mediante la personalización, 201 representa un nuevo recurso, pero ¿y si olvidamos el número correspondiente al usar el código de estado? Aquí fastapi es muy íntimo, nos proporciona valores de enumeración:

También disponible aquí from starlette import status.

Código de estado HTTP

• Por encima de 100 significa "información". Rara vez los usamos directamente. Las respuestas con estos códigos de estado no pueden tener cuerpo.
• 200 y superiores indican una respuesta de "éxito". Estos son los más utilizados.
  • El código de estado predeterminado es 200, lo que significa que todo está bien.
  • Otro ejemplo es 201, "Creado". Generalmente se usa después de que se ha creado un nuevo registro en la base de datos.
  • El caso especial es 204, "Sin contenido". Esta respuesta se usa cuando no se devuelve contenido al cliente, por lo que la respuesta no debe tener cuerpo.
• 300 y superiores se utilizan para "redirecciones". Las respuestas con estos códigos de estado pueden o no tener un cuerpo, a excepción de 304, "No modificado", que NO DEBE tener uno.
• 400 y superiores son para respuestas de "error de cliente". Estos son probablemente el segundo tipo que se usa con más frecuencia.
  • Para una respuesta "No encontrado", un ejemplo sería 404.
  • Para errores generales de los clientes, puede usar 400.
• 500 y superiores son errores del servidor. Casi nunca los usamos directamente. Cuando algo sale mal en el código de su aplicación o en su servidor, automáticamente devolverá uno de estos códigos de estado.

Las castañas anteriores están todas puestas en git, dirección: haga clic aquí