PyCharm运行FastAPI服务器教程

轻松运行PyCharm中的FastAPI服务器！本文介绍两种便捷方法，助您告别命令行，直接在PyCharm中启动FastAPI应用。

方法一：直接在代码中启动服务器

此方法需要修改您的main.py文件，在代码中直接调用uvicorn.run()函数。

首先，修改您的main.py文件如下：

import uvicorn
from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
    return {"hello": "world"}

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

接下来，在PyCharm中进行如下配置：

1. 运行/调试配置: 选择“运行” -> “编辑配置”。
2. 脚本路径: 指向您的main.py文件。
3. Python解释器: 选择您的项目使用的Python解释器或虚拟环境。
4. 工作目录: 设置为您的FastAPI项目根目录。

配置完成后，点击运行按钮即可启动服务器。

方法二：使用PyCharm运行uvicorn命令

此方法无需修改您的main.py文件，直接在PyCharm中执行uvicorn命令。您的main.py文件保持原样：

from fastapi import FastAPI

app = FastAPI()

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

在PyCharm中，进行如下配置：

1. 运行/调试配置: 选择“运行” -> “编辑配置”。
2. 工具: 选择“外部工具”。
3. 名称: 例如，“运行FastAPI”。
4. 程序: 指向您的uvicorn可执行文件（如果未配置环境变量，则需要指定完整路径，例如：/usr/local/bin/uvicorn 或 C:\Python39\Scripts\uvicorn.exe）。
5. 参数: 输入main:app --reload，其中main是您的主模块名称，app是您的FastAPI应用实例名称，--reload参数用于自动重新加载代码更改。
6. 工作目录: 设置为您的FastAPI项目根目录。

配置完成后，点击运行按钮即可启动服务器。

两种方法都能在PyCharm中高效运行FastAPI服务器，选择最适合您的方法即可。