如何创建一个 FastAPI 应用？

推荐答案

from fastapi import FastAPI

app = FastAPI()

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

本题详细解读

1. 导入 FastAPI

首先，你需要从 fastapi 模块中导入 FastAPI 类。FastAPI 是一个用于构建 API 的现代、快速（高性能）的 Web 框架。

from fastapi import FastAPI

2. 创建 FastAPI 实例

接下来，你需要创建一个 FastAPI 的实例。这个实例将是你的应用的核心对象，所有的路由和请求处理都将通过它来管理。

app = FastAPI()

3. 定义路由和处理函数

你可以使用 @app.get() 装饰器来定义一个路由。在这个例子中，我们定义了一个根路径 / 的路由，并指定了一个处理函数 read_root。当用户访问根路径时，这个函数将被调用，并返回一个 JSON 响应。

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

4. 运行应用

你可以使用 uvicorn 来运行这个 FastAPI 应用。假设你的文件名为 main.py，你可以通过以下命令来启动应用：

uvicorn main:app --reload

• main 是文件名（不包括 .py 扩展名）。
• app 是你在代码中创建的 FastAPI 实例。
• --reload 选项会在代码更改时自动重新加载应用，方便开发调试。

5. 访问应用

启动应用后，你可以在浏览器中访问 http://127.0.0.1:8000/，你将看到返回的 JSON 响应：

{
  "message": "Hello, World!"
}

6. 自动生成的文档

FastAPI 还自动生成了交互式 API 文档。你可以访问以下 URL 来查看文档：

• Swagger UI: http://127.0.0.1:8000/docs
• ReDoc: http://127.0.0.1:8000/redoc

这些文档可以帮助你快速了解 API 的功能，并且可以直接在浏览器中进行 API 调用测试。