Skip to content

快速入门

如果想要最快体验 FastAPI，可能只需要编写一个内容如下的文件：

from fastapi import FastAPI

app = FastAPI()


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

把这些内容复制到一个文件中，保存为 main.py。

然后在终端命令行中运行下面这个命令，启动实时服务：

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

笔记

命令 uvicorn main:app 解释：

  • main: 代表 main.py 文件（也是Python中的"module"）
  • app: 在 main.py 文件中 app = FastAPI() 创建的对象
  • --reload: 将服务设置为热更新模式，热更新模式是指在代码有改动的时候，自动重新启动服务，这个命令只适用于开发阶段，生产上线时不要启动这个配置

输出内容里，有一行像这样的：

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

这一行展示了刚刚在你本地机器中启动的app监听的URL。

验证服务

打开你的浏览器，访问：http://127.0.0.1:8000

你会看到 JSON 格式的返回内容：

{"message": "Hello World"}

交互式的API文档

现在继续访问http://127.0.0.1:8000/docs

你会看到自动化生成的带交互式API文档（由 Swagger UI提供）。