CORE Code School
Construye una API en Python con FastAPI
馃殌 Instalaci贸n
datapythonbootcamp

Construye una API en Python con FastAPI

16 minutos

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.

Terminal
pip install fastapi
Copiar

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

Terminal
pip install uvicorn
Copiar

馃崯 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}
Copiar

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.

Terminal
uvicorn main:app --reload
Copiar

"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" }
Copiar

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!

En esta p谩gina
馃殌 Instalaci贸n馃崯 Crear la API馃崟 Ejecutar nuestra ApiComprobar funcionamiento馃 Documentaci贸n autom谩tica
Actualizado 05 dic 2022
驴Quieres m谩s?
datapythonbootcamp

F贸rmate como desarrollador@