如何在PyCharm中轻松运行FastAPI服务器？

在PyCharm中运行FastAPI服务器非常简单。以下是详细步骤：

1. 安装FastAPI和Uvicorn

首先，确保你已经安装了FastAPI和Uvicorn。Uvicorn是一个ASGI服务器，用于运行FastAPI应用。

你可以使用以下命令安装它们：

pip install fastapi uvicorn

2. 创建FastAPI应用

在你的项目目录中创建一个Python文件（例如main.py），并编写一个简单的FastAPI应用：

from fastapi import FastAPI

app = FastAPI()

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

3. 配置PyCharm运行配置

接下来，你需要在PyCharm中配置一个运行配置来启动FastAPI服务器。

1. 打开运行配置：

   • 点击PyCharm右上角的“Add Configuration”按钮（或者通过菜单栏的 Run > Edit Configurations）。

2. 添加新的运行配置：

   • 点击左上角的 + 按钮，选择 Python。

3. 配置运行参数：

   • Script path: 选择你刚刚创建的main.py文件。
   • Parameters: 输入 --reload，这样Uvicorn会在代码更改时自动重新加载服务器。
   • Working directory: 选择你的项目目录。

4. 设置环境变量（可选）：

   • 如果你需要设置环境变量，可以在 Environment variables 字段中添加。

5. 保存配置：

   • 点击 Apply 和 OK 保存配置。

4. 运行FastAPI服务器

现在，你可以通过点击PyCharm右上角的绿色运行按钮来启动FastAPI服务器。服务器启动后，你可以在浏览器中访问 http://127.0.0.1:8000/ 来查看你的FastAPI应用。

5. 查看API文档

FastAPI自动生成了交互式API文档，你可以通过以下URL访问：

• Swagger UI: http://127.0.0.1:8000/docs
• ReDoc: http://127.0.0.1:8000/redoc

6. 调试FastAPI应用

如果你需要在PyCharm中调试FastAPI应用，可以直接在代码中设置断点，然后使用调试模式运行配置。PyCharm会启动调试器，并在断点处暂停执行。

总结

通过以上步骤，你可以在PyCharm中轻松运行和调试FastAPI服务器。PyCharm的强大功能使得开发和调试FastAPI应用变得更加高效和便捷。