如何使用 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 服务器？

Answer 1

方法一：调用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 的配置中设置脚本路径

注意事项

• 脚本路径：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 来获取路径。 (See this image)
• 参数：uvicorn命令的实际参数
• Python 解释器：选择您的解释器/虚拟环境
• 工作目录：您的 FastAPI 项目根目录

Answer 2

你可以在main.py中不添加代码

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

Answer 3

尝试在您的代码中调用 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")

Reference

Answer 4

另一个例子，这可能对某人有帮助。

# fastapi_demo.py

import uvicorn
from fastapi import FastAPI, Response

app = FastAPI()

@app.route('/', methods=['POST'])
def demo(request):
    try:
        print(request)
    except Exception as e:
        print(e)
    return Response(content='OK')


if __name__ == '__main__':
    uvicorn.run(app='fastapi_demo:app')