· 约 2 分钟

10-FastAPI基础入门-响应类型-JSON格式

  • FastAPI
  • Python

学习目标

核心概念

FastAPI 默认最常见的响应格式就是 JSON。
当你返回:

FastAPI 通常都会自动转成 JSON 响应。

代码示例

最简单的写法:

from fastapi import FastAPI

app = FastAPI()


@app.get("/ping")
def ping():
    return {"message": "pong"}

如果你需要更明确控制状态码或返回体,可以用 JSONResponse

from fastapi import FastAPI
from fastapi.responses import JSONResponse

app = FastAPI()


@app.post("/login")
def login():
    return JSONResponse(
        status_code=200,
        content={"code": 0, "message": "login success", "data": {"token": "abc123"}},
    )

什么时候用默认返回,什么时候用 JSONResponse

易错点

我的补充

项目里最好统一一个 JSON 响应风格,例如:

{
  "code": 0,
  "message": "success",
  "data": {}
}

这样后面你做异常处理和接口封装会轻松很多。