Construye una API en Python con FastAPI

FastAPI es una librería muy útil para todos aquellos desarrolladores Python que quieran implementar una API.

Este nos permitirá desarrollar una API de la que podremos ir probando sus resultados. Podremos también conectarla a una Base de Datos SQL o NOSQL como por ejemplo MongoDB.

🚀 Instalación

Su instalación es muy sencilla, además de FastApi vamos a necesitar Uvicorn para su funcionamiento.

bash
pip install fastapi

Instalamos Uvicorn (Nos va a permitir crear un server remoto desde nuestro ordenador para que se ejecute la Api)

bash
pip install uvicorn

🍟 Crear la API

Para realizar nuestra primer api vamos a crear un archivo .py, como recomendación que se llame "main.py" e introducimos el siguiente código

python
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def test():
  return {"Hello": "World"}

@app.get("/saludo/{name}")
def read_item(name):
  return {"Te saludo":name}

Este es un código básico el cual nos ejecutará nuestra Api con dos funcionalidades, la primera será la página inicial "/". Entraremos al iniciar la api, es importante asignarle un return aunque sea básico para corroborar que nuestra api está funcionando.

La segunda funcionalidad nos permite devolver un mensaje predeterminado con una variable, en este caso el nombre, que será asignado en el URL de la web.

🍕 Ejecutar nuestra Api

Para ejecutarla vamos a tener que usar el paquete descargado anteriormente "Uvicorn" para esto vamos a abrir nuestra terminal y en la carpeta donde esté nuestro archivo "main.py" ejecutamos el siguiente código.

bash
uvicorn main:app --reload

"main" debe ser remplazado por el nombre del archivo de nuestra api

Veremos un código similar al siguiente (En el recuadro naranja nos saldrá una url de números, esa misma es nuestra API)

Comprobar funcionamiento

Para comprobar si está en perfecto funcionamiento simplemente tendremos que colocar la url que nos da Uvicorn en nuestro navegador y observar si nos da nuestro return de prueba. En este caso:

json
{ "Hello": "World" }

Para APIs más complejas recomendamos el uso de Postman ya que nos va a permitir ver el código Json de la api de una forma más ordenado

🥓 Documentación automática

FastApi te genera una documentación automática, ayudando a ver todas las ramas qué se han generado, para acceder a la misma basta únicamente con poner al final /docs y verás algo similar a esto.

Se irá actualizando cada vez que agregues una nueva función a tu api, de esta forma podrás conocer la útilidad de apis que descargues, siempre y cuando sean con FastApi.

En próximos tutoriales te explicaremos como conectarte con una base de datos y poder usar la información que hay allí.

¡Todo listo!