8.3. Hello World¶
El objeto de esta sección es hacer un demostración local de Hello World en framework FastAPI.
8.3.1. Requisitos previos¶
Para trabajar una aplicación FastAPI requiere instalar la siguiente
librería:
Requisitos previos para FastAPI framework.
8.3.2. Estructura de proyecto¶
Crear estructura de proyecto FastAPI, con los siguientes comando:
mkdir -p ~/proyectos/fastapi/helloworld/ && cd $_
Cree módulo Python llamado main.py dentro del directorio ~/proyectos/fastapi/helloworld
nano main.py
Agregue el siguiente contenido al archivo ~/proyectos/fastapi/helloworld/main.py.
from fastapi import FastAPI
# Create an instance of the FastAPI class
app = FastAPI()
@app.get("/")
async def root():
"""A simple hello world endpoint."""
return {"message": "Hello World"}
Para ejecutar el código del proyecto llamado helloworld abra una consola de comando, cree la
siguiente estructura de directorio y acceda al mismo donde se encuentra el programa:
proyectos/
└── fastapi/
└── helloworld/
└── main.py
Si tiene la estructura de archivo previa, entonces puede continuar los procesos de instalación, configuración y ejecución del código fuente.
8.3.3. Ejecutar aplicación FastAPI¶
Para ejecutar aplicación Web FastAPI, con el siguiente comando:
fastapi dev main.py
Abra una nueva ventana de terminal para probar la API utilizando un cliente HTTP como comando curl.
8.3.4. Hacer peticiones¶
El comando curl le permite probar rápidamente una API desde el terminal sin
la necesidad de tener que descargar una aplicación específica.
8.3.4.1. request GET con response 200¶
curl -X GET http://127.0.0.1:8000/
El comando anterior muestra cómo realizar una petición GET para obtener el
mensaje Hello World.
De esta forma, se puede ver que la API funciona correctamente mediante las peticiones a la API usando el comando curl.
8.3.5. Documentación generada¶
Puede acceder a la documentación auto-generada en los siguientes enlaces:
8.3.5.1. Documentación interactiva de la API¶
De esta forma, una vez ejecutado el comando, se puede abrir desde con su navegador Web favorito (Mozilla Firefox, Google Chrome, etc) la siguiente dirección: http://127.0.0.1:8000/docs
Figura 8.3, Documentación interactiva de la API¶
Verás la documentación interactiva automática de la API (proporcionada por Swagger UI).
8.3.5.2. Documentación de API Alternativa¶
Y ahora, valla a abrir desde con su navegador Web favorito (Mozilla Firefox, Google Chrome, etc) la siguiente dirección: http://127.0.0.1:8000/redoc
Figura 8.4, Documentación de API Alternativa¶
Verás la documentación alternativa automática (proporcionada por Redoc).
Nota
El código ejemplo usado puede encontrarlo en: https://github.com/macagua/example.fastapi.helloworld
Ver también
Consulte la sección de lecturas suplementarias del entrenamiento para ampliar su conocimiento en esta temática.
¿Cómo puedo ayudar?
¡Mi soporte está aquí para ayudar!
Mi horario de oficina es de lunes a sábado, de 9 AM a 5 PM. UTM - Madrid, España.
La hora aquí es actualmente 7:35 PM UTM.
Mi objetivo es responder a todos los mensajes dentro de un día hábil.
