问题:如何使用Pycharm运行fast-api服务器?

我有一个简单的 API 函数如下,

from fastapi import FastAPI

app = FastAPI()


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

我正在使用 uvicorn 命令启动服务器,

uvicorn main:app

由于我们没有直接调用任何 python 文件,因此无法从 Pycharm 调用uvicorn命令。

那么,如何使用 Pycharm 运行 fast-api 服务器?

解答

方法一:调用uvicorn.run(...)运行 FastAPI

在这种情况下,您的最小代码如下,

# 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)

通常,您将通过运行以下命令来启动服务器,

python main.py

Pycharm 设置

对于这个设置,现在,您可以在 Pycharm 的配置中设置脚本路径

笔记

• Script Path:FastAPI 脚本的路径

• Python解释器:选择你的解释器/虚拟环境

• 工作目录:你的 FastAPI 项目根目录

方法二:调用uvicorn命令运行FastAPI

在这种情况下,您的最小代码如下,

# main.py

from fastapi import FastAPI

app = FastAPI()


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

通常,您将通过运行以下命令来启动服务器,

uvicorn main:app --reload

Pycharm 设置

对于这个设置,现在,您可以在 Pycharm 的配置中设置脚本路径

笔记

• 模块名称:设置为uvicorn

• [可选] 脚本:uvicorn二进制文件的路径。您将通过在您的环境中执行命令 which uvicorn 来获取路径。 (见这张图片)

• 参数:uvicorn命令的实际参数

• Python解释器:选择你的解释器/虚拟环境

• 工作目录:你的 FastAPI 项目根目录