如何使用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 命令。

那么，我怎样才能运行快速的api服务器使用Py

Answer 1

尝试在代码中调用uvicorn。例如：

from fastapi import FastAPI
import uvicorn

app = FastAPI()


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

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

参考

Answer 2

您无需向main.py添加代码即可完成此操作

1. 在要运行的目标而不是脚本路径中，选择模块名称
2. 在模块名称中键入 uvicorn
3. 在参数中 app.main：app --reload --port 5000

Answer 3

在这种情况下，最少的代码如下:

# 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 的配置中设置脚本路径

• 脚本路径：FastAPI脚本的路径
• Python解释器：选择解释器/虚拟环境
• 工作目录：您的FastAPI项目根目录

在这种情况下，最少的代码如下:

# main.py

from fastapi import FastAPI

app = FastAPI()


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

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

uvicorn main:app --reload

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

• 模块名称：设置为 uvicorn
• [可选] 脚本：指向 uvicorn 二进制文件的路径。您将通过执行命令来获取路径， 哪个 uvicorn ，在您的环境中。（见此图）
参数
• ：uvicorn命令的实际参数
Python 解释器
• ：选择您的解释器/虚拟环境
• 工作目录：您的 FastAPI 项目根目录