Tutorial - Guía de Usuario¶

Este tutorial te muestra cómo usar FastAPI con la mayoría de sus características, paso a paso.

Cada sección se construye gradualmente sobre las anteriores, pero está estructurada para separar temas, de modo que puedas ir directamente a cualquiera específico para resolver tus necesidades específicas de API.

También está construido para funcionar como referencia futura para que puedas volver y ver exactamente lo que necesitas.

Ejecutar el código¶

Todos los bloques de código pueden ser copiados y usados directamente (son archivos Python testeados reales).

Para ejecutar cualquiera de los ejemplos, copia el código a un archivo main.py, e inicia fastapi dev:


<font color="#4E9A06">fastapi</font> devfast →fastapi dev
   FastAPI   Starting development server 🚀

             Searching for package file structure from directories
             with __init__.py files
             Importing from /home/user/code/awesomeapp

    module   🐍 main.py

      code   Importing the FastAPI app object from the module with
             the following code:

             from main import app

       app   Using import string: main:app

    server   Server started at http://127.0.0.1:8000
    server   Documentation at http://127.0.0.1:8000/docs

       tip   Running in development mode, for production use:
             fastapi run

             Logs:

      INFO   Will watch for changes in these directories:
             ['/home/user/code/awesomeapp']
      INFO   Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C
             to quit)
      INFO   Started reloader process [383138] using WatchFiles
      INFO   Started server process [383153]
      INFO   Waiting for application startup.
      INFO   Application startup complete.

restart ↻

Es MUY recomendable que escribas o copies el código, lo edites y lo ejecutes localmente.

Usarlo en tu editor es lo que realmente te muestra los beneficios de FastAPI, viendo qué poco código tienes que escribir, todas las comprobaciones de tipos, autocompletado, etc.

Instalar FastAPI¶

El primer paso es instalar FastAPI.

Asegúrate de crear un entorno virtual, activarlo, y luego instalar FastAPI:


pip install "fastapi[standard]"fast →pip install "fastapi[standard]"

restart ↻

Nota

Cuando instalas con pip install "fastapi[standard]" viene con algunas dependencias estándar opcionales por defecto, incluyendo fastapi-cloud-cli, que te permite desplegar en FastAPI Cloud.

Si no quieres tener esas dependencias opcionales, puedes instalar pip install fastapi en su lugar.

Si quieres instalar las dependencias estándar pero sin el fastapi-cloud-cli, puedes instalar con pip install "fastapi[standard-no-fastapi-cloud-cli]".

Consejo

FastAPI tiene una extensión oficial para VS Code (y Cursor), que proporciona muchas características, incluyendo un explorador de path operations, búsqueda de path operations, navegación CodeLens en tests (saltar a la definición desde los tests), y despliegue y logs de FastAPI Cloud, todo desde tu editor.

Guía de Usuario Avanzada¶

También hay una Guía de Usuario Avanzada que puedes leer después de este Tutorial - Guía de Usuario.

La Guía de Usuario Avanzada se basa en esta, usa los mismos conceptos, y te enseña algunas características adicionales.

Pero primero deberías leer el Tutorial - Guía de Usuario (lo que estás leyendo ahora mismo).

Está diseñado para que puedas construir una aplicación completa con solo el Tutorial - Guía de Usuario, y luego extenderla de diferentes maneras, dependiendo de tus necesidades, usando algunas de las ideas adicionales de la Guía de Usuario Avanzada.