Configuración de Pycharm para Proyectos FastAPI

Configuración de PyCharm para Proyectos FastAPI

Introducción

FastAPI es un framework web de Python moderno, rápido y eficiente para el desarrollo de APIs. PyCharm es un entorno de desarrollo integrado (IDE) para Python que proporciona una serie de herramientas y funcionalidades que pueden ayudar a los desarrolladores a crear y mantener proyectos FastAPI.

En este tutorial, veremos cómo configurar PyCharm para proyectos FastAPI.

Requisitos

Para seguir este tutorial, necesitarás lo siguiente:

• PyCharm Community Edition o Professional Edition
• Python 3.7 o superior
• FastAPI

Instalar FastAPI

Si aún no tienes FastAPI instalado, puedes instalarlo usando pip:

pip install fastapi

Crear un nuevo proyecto FastAPI

Para crear un nuevo proyecto FastAPI en PyCharm, sigue estos pasos:

1. Abre PyCharm y selecciona File > New > Project.
2. En la ventana New Project, selecciona Python > Web > FastAPI.
3. Haz clic en Next.
4. En la ventana Project Name, introduce un nombre para tu proyecto.
5. Haz clic en Create.

Configurar el intérprete de Python

Antes de poder ejecutar tu proyecto, necesitas configurar el intérprete de Python.

1. En la barra de menú, selecciona File > Settings.
2. En la ventana Settings, expande Project > Python Interpreter.
3. Haz clic en el botón Add.
4. En la ventana Add Python Interpreter, selecciona System Interpreter.
5. Haz clic en OK.

Crear una API simple

Para crear una API simple, abre el archivo main.py en PyCharm.

Añade el siguiente código al archivo main.py:

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def index():
    return {"message": "Hello, world!"}

if __name__ == "__main__":
    app.run()

Este código crea una API simple que responde con el mensaje «Hello, world!» cuando se accede a la ruta /.

Ejecutar la API

Para ejecutar la API, haz clic en el botón Run en la barra de herramientas.

Una vez que la API esté en ejecución, puedes acceder a ella en tu navegador web. Abre tu navegador y accede a la siguiente URL:

http://localhost:8000

Deberías ver el siguiente mensaje:

{
    "message": "Hello, world!"
}

Configuración adicional

Además de los pasos anteriores, puedes configurar PyCharm para proyectos FastAPI de la siguiente manera:

• Añadir el decorador @app.get("/docs") al archivo main.py. Esto creará una página de documentación para tu API.
• Añadir el decorador @app.debug al archivo main.py. Esto habilitará el modo de depuración para tu API.

Conclusión

En este tutorial, has aprendido a configurar PyCharm para proyectos FastAPI. Ahora puedes comenzar a crear y mantener tus propias APIs con FastAPI.

Referencias

• FastAPI documentation: https://fastapi.tiangolo.com/
• PyCharm documentation: https://www.jetbrains.com/help/pycharm/