目录

  1. 创建 FastAPI 应用
  2. 运行 FastAPI 应用
  3. 访问 FastAPI 应用
  4. 自动生成文档
  5. 参考资料

1. 创建 FastAPI 应用

在 FastAPI 中创建一个应用非常简单。你只需要几行代码就可以定义一个基本的 API。

步骤：

  1. 创建一个 Python 文件：

创建一个名为 main.py 的 Python 文件，用于编写 FastAPI 应用代码。

touch main.py
  1. 编写 FastAPI 应用代码：

在 main.py 文件中编写以下代码：

# main.py
from fastapi import FastAPI

# 创建 FastAPI 实例
app = FastAPI()

# 定义根路由
@app.get("/")
def read_root():
    return {"message": "Hello, World!"}
  • FastAPI()：创建 FastAPI 应用实例。
  • @app.get("/")：定义一个 GET 请求的路由，表示访问根路径 / 时，返回一个 JSON 响应。
  • read_root()：视图函数，返回一个简单的字典，FastAPI 会自动将其转换为 JSON 响应。

2. 运行 FastAPI 应用

为了运行 FastAPI 应用，你需要使用 Uvicorn 作为 ASGI 服务器。

步骤：

  1. 在终端中运行以下命令启动 Uvicorn：
uvicorn main:app --reload
  • main:app：指定 main.py 文件中的 app 实例。
  • --reload：启用自动重载，使代码修改后自动重新启动应用，方便开发。

你会看到类似以下的输出，表示应用已经成功启动：

INFO:     Will watch for changes in these directories: ['.', 'app']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

3. 访问 FastAPI 应用

现在，打开浏览器并访问 http://127.0.0.1:8000。你应该会看到返回的 JSON 响应：

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

这表示你的第一个 FastAPI 应用已经成功运行。

4. 自动生成文档

FastAPI 会自动为你的 API 生成文档，并且提供了交互式的界面。你可以通过以下 URL 访问：

  • Swagger UI：提供了交互式的 API 文档，可以直接通过界面进行请求。
  • ReDoc：另一种样式的文档，适用于查看 API 结构和细节。

这些文档是基于 OpenAPI 规范自动生成的，帮助你更好地理解和测试 API。

5. 参考资料

出站链接

站内链接