Scribd
Cargar
4 vistas10 páginas

TUTORIAL

El documento describe los primeros pasos para crear una API utilizando FastAPI, incluyendo la configuración del servidor y la generación de documentación automática a través de OpenAPI. Se detallan los pasos para importar FastAPI, crear una instancia de la aplicación, definir rutas y operaciones HTTP, así como la forma de devolver contenido en formato JSON. Además, se menciona cómo acceder a la documentación interactiva y el esquema OpenAPI generado automáticamente.

Cargado por

Alexandra
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como DOCX, PDF, TXT o lee en línea desde Scribd
4 vistas10 páginas

TUTORIAL

El documento describe los primeros pasos para crear una API utilizando FastAPI, incluyendo la configuración del servidor y la generación de documentación automática a través de OpenAPI. Se detallan los pasos para importar FastAPI, crear una instancia de la aplicación, definir rutas y operaciones HTTP, así como la forma de devolver contenido en formato JSON. Además, se menciona cómo acceder a la documentación interactiva y el esquema OpenAPI generado automáticamente.

Cargado por

Alexandra
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como DOCX, PDF, TXT o lee en línea desde Scribd
Está en la página 1/ 10

FIRST STEPS

El archivo FastAPI más simple podría verse así:

Ejecute el servidor en vivo:

En la salida, hay una línea con algo como:

Esa línea muestra la URL donde se sirve tu aplicación, en tu máquina


local.
Compruébalo. Abra su navegador en http://127.0.0.1:8000.

Verá la respuesta JSON como:

DOCUMENTACIÓN API INTERACTIVA

Ahora ve a http://127.0.0.1:8000/docs. Verá la documentación


automática de la API interactiva (proporcionada por Interfaz de
usuario Swagger):
DOCUMENTACIÓN DE API ALTERNATIVA

Y ahora, vamos a http://127.0.0.1:8000/redoc.

Verá la documentación automática alternativa (proporcionada por


ReDoc):
API ABIERTA

FastAPI genera un "esquema" con todas sus API utilizando el


estándar OpenAPI para definir API.

"ESQUEMA"

Un "esquema" es una definición o descripción de algo. No es el código


que lo implementa, sino simplemente una descripción abstracta.

"ESQUEMA" DE API

En este caso, OpenAPI es una especificación que dicta cómo definir un


esquema de su API.

Esta definición de esquema incluye sus rutas de API, los posibles


parámetros que toman, etc.

"ESQUEMA" DE DATOS

El término "esquema" también podría referirse a la forma de algunos


datos, como un contenido JSON.

En ese caso, se referiría a los atributos JSON y los tipos de datos que
tienen, etc.

OPENAPI Y ESQUEMA JSON

OpenAPI define un esquema de API para su API. Este esquema incluye


definiciones (o "esquemas") de los datos enviados y recibidos por su API
mediante el esquema JSON, el estándar para esquemas de datos
JSON.

COMPRUEBA EL OPENAPI.JSON

Si tiene curiosidad sobre cómo se ve el esquema OpenAPI sin procesar,


FastAPI genera automáticamente un JSON (esquema) con las
descripciones de todas sus API.

Puedes verlo directamente en: http://127.0.0.1:8000/openapi.json.

Mostrará un JSON que comienza con algo como:


¿PARA QUÉ SIRVE OPENAPI?

El esquema OpenAPI es lo que impulsa los dos sistemas de


documentación interactiva incluidos.

Existen docenas de alternativas, todas basadas en OpenAPI. Puedes


añadir fácilmente cualquiera de ellas a tu aplicación creada
con FastAPI.

También puedes usarlo para generar código automáticamente para


clientes que se comunican con tu API. Por ejemplo, aplicaciones
frontend, móviles o IoT.

RESUMEN, PASO A PASO

Paso 1: importar FastAPI

FastAPI es una clase de Python que proporciona toda la funcionalidad


para su API
Paso 2: crear una FastAPI "instancia"

Aquí la app variable será una "instancia" de la clase FastAPI.

Este será el punto principal de interacción para crear toda tu API.

Paso 3: crear una operación de ruta

Path

"Ruta" aquí se refiere a la última parte de la URL comenzando desde el


primer /.

Entonces, en una URL como:

...el path seria:

Al crear una API, la "ruta" es la forma principal de separar


"preocupaciones" y "recursos".
Operación

"Operación" aquí se refiere a uno de los "métodos" HTTP.

Uno de:

 POST
 GET
 PUT
 DELETE
...y los más exóticos:

 OPTIONS
 HEAD
 PATCH
 TRACE
En el protocolo HTTP, puedes comunicarte con cada ruta utilizando uno
(o más) de estos "métodos".

Al crear API, normalmente se utilizan estos métodos HTTP específicos


para realizar una acción específica.

Normalmente se utiliza:

 POST:para crear datos.


 GET:leer datos.
 PUT:para actualizar datos.
 DELETE:para borrar datos.

Entonces, en OpenAPI, cada uno de los métodos HTTP se denomina


"operación".

Las llamaremos también " operaciones ".

Definir un decorador de operaciones de ruta


Le @app.get("/") dice a FastAPI que la función que se encuentra justo
debajo es la encargada de manejar las solicitudes que van a:

 el path /
 usando una get operación

También puedes utilizar las otras operaciones:

 @app.post()
 @app.put()
 @app.delete()
Y los más exóticos:

 @app.options()
 @app.head()
 @app.patch()
 @app.trace()

Paso 4: definir la función de operación de ruta

Esta es nuestra " función de operación de ruta ":

 ruta: es /.
 operación: es get.
 función: es la función debajo del "decorador"
(abajo @app.get("/")).

Esta es una función de Python.

FastAPI lo llamará cada vez que reciba una solicitud a la URL " /"
mediante una GET operación.

En este caso, se trata de una async función.

También podría definirse 8como una función normal en lugar de async


def:

Paso 5: devolver el contenido


Puede devolver valores singulares como dict, list, str, int, etc.

También puedes devolver modelos de Pydantic (verás más sobre esto


más adelante).

Hay muchos otros objetos y modelos que se convertirán


automáticamente a JSON (incluidos ORM, etc.). Prueba a usar tus
favoritos; es muy probable que ya sean compatibles.

RESUMEN

 Importar FastAPI.

 Crear una app instancia.

 Escriba un decorador de operaciones de ruta utilizando


decoradores como @app.get("/").

 Define una función de operación de ruta; por ejemplo, def


root(): ....

 Ejecute el servidor de desarrollo utilizando el comando fastapi


dev.

También podría gustarte