Código de Estado del Response¶
🌐 Traducción por IA y humanos
Esta traducción fue hecha por IA guiada por humanos. 🤝
Podría tener errores al interpretar el significado original, o sonar poco natural, etc. 🤖
Puedes mejorar esta traducciónayudándonos a guiar mejor al LLM de IA.
De la misma manera que puedes especificar un modelo de response, también puedes declarar el código de estado HTTP usado para el response con el parámetrostatus_code en cualquiera de laspath operations:
@app.get()@app.post()@app.put()@app.delete()- etc.
fromfastapiimportFastAPIapp=FastAPI()@app.post("/items/",status_code=201)asyncdefcreate_item(name:str):return{"name":name}Nota
Observa questatus_code es un parámetro del método "decorador" (get,post, etc). No de tupath operation function, como todos los parámetros y body.
El parámetrostatus_code recibe un número con el código de estado HTTP.
Información
status_code también puede recibir unIntEnum, como por ejemplo elhttp.HTTPStatus de Python.
Esto hará:
- Devolver ese código de estado en el response.
- Documentarlo como tal en el esquema de OpenAPI (y por lo tanto, en las interfaces de usuario):
Nota
Algunos códigos de response (ver la siguiente sección) indican que el response no tiene un body.
FastAPI sabe esto, y producirá documentación OpenAPI que establece que no hay un response body.
Acerca de los códigos de estado HTTP¶
Nota
Si ya sabes qué son los códigos de estado HTTP, salta a la siguiente sección.
En HTTP, envías un código de estado numérico de 3 dígitos como parte del response.
Estos códigos de estado tienen un nombre asociado para reconocerlos, pero la parte importante es el número.
En breve:
100 - 199son para "Información". Rara vez los usas directamente. Los responses con estos códigos de estado no pueden tener un body.200 - 299son para responses "Exitosos". Estos son los que usarías más.200es el código de estado por defecto, lo que significa que todo estaba "OK".- Otro ejemplo sería
201, "Created". Comúnmente se usa después de crear un nuevo registro en la base de datos. - Un caso especial es
204, "No Content". Este response se usa cuando no hay contenido para devolver al cliente, por lo tanto, el response no debe tener un body.
300 - 399son para "Redirección". Los responses con estos códigos de estado pueden o no tener un body, excepto304, "Not Modified", que no debe tener uno.400 - 499son para responses de "Error del Cliente". Este es el segundo tipo que probablemente más usarías.- Un ejemplo es
404, para un response "Not Found". - Para errores genéricos del cliente, puedes usar simplemente
400.
- Un ejemplo es
500 - 599son para errores del servidor. Casi nunca los usas directamente. Cuando algo sale mal en alguna parte de tu código de aplicación, o del servidor, automáticamente devolverá uno de estos códigos de estado.
Consejo
Para saber más sobre cada código de estado y qué código es para qué, revisa ladocumentación deMDN sobre códigos de estado HTTP.
Atajo para recordar los nombres¶
Veamos de nuevo el ejemplo anterior:
fromfastapiimportFastAPIapp=FastAPI()@app.post("/items/",status_code=201)asyncdefcreate_item(name:str):return{"name":name}201 es el código de estado para "Created".
Pero no tienes que memorizar lo que significa cada uno de estos códigos.
Puedes usar las variables de conveniencia defastapi.status.
fromfastapiimportFastAPI,statusapp=FastAPI()@app.post("/items/",status_code=status.HTTP_201_CREATED)asyncdefcreate_item(name:str):return{"name":name}Son solo una conveniencia, mantienen el mismo número, pero de esa manera puedes usar el autocompletado del editor para encontrarlos:
Detalles técnicos
También podrías usarfrom starlette import status.
FastAPI proporciona el mismostarlette.status comofastapi.status solo como una conveniencia para ti, el desarrollador. Pero proviene directamente de Starlette.
Cambiando el valor por defecto¶
Más adelante, en laGuía de Usuario Avanzada, verás cómo devolver un código de estado diferente al valor por defecto que estás declarando aquí.