如何使用 Pycharm 运行 fast-api 服务器？

Question

我有一个简单的 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 服务器？

原文由 JPG 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

方法 1：通过调用运行 FastAPI 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)

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

 python main.py

Pycharm 设置

对于此设置，现在，您可以在 Pycharm 的配置中设置脚本路径

笔记

• 脚本路径：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 项目根目录

原文由 JPG 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 2

您可以在不向 main.py 添加代码的情况下执行此操作

1. 在 target to run 而不是 Script path 选择 Module name
2. 在 Module name 输入 uvicorn
3. 在参数 app.main:app --reload --port 5000

原文由 Jonhy Beebop 发布，翻译遵循 CC BY-SA 4.0 许可协议