4.3 自定义响应类：JSONResponse、HTMLResponse

FastAPI入门教程：自定义响应类JSONResponse与HTMLResponse详解

FastAPI 教程

面向Python初学者的FastAPI入门教程，重点讲解如何使用自定义响应类如JSONResponse和HTMLResponse。通过生活化类比和简单示例，快速上手，建立Web开发信心。

FastAPI入门教程：自定义响应类详解

欢迎来到FastAPI的世界！如果你熟悉Python语法但对Web开发感到陌生，别担心。FastAPI就像一个高效的快递员，帮你轻松处理网络请求和响应。本教程将带你快速上手，重点学习如何自定义响应，特别是JSONResponse和HTMLResponse。我们会用简单类比和动手实践来建立你的信心，让你在几分钟内看到自己的成功时刻！

1. 准备工作：安装和第一个应用

首先，让我们设置环境。确保你已经安装了Python（建议版本3.7以上），然后打开终端或命令提示符。

安装FastAPI和服务器：运行以下命令安装FastAPI和uvicorn（一个用于运行FastAPI的服务器）。
```
pip install fastapi uvicorn
```
创建你的第一个FastAPI应用：创建一个新文件，比如 main.py，并输入以下代码。
```
from fastapi import FastAPI

app = FastAPI()  # 创建一个FastAPI实例，就像给你的快递员起了个名字

@app.get("/hello")
def say_hello():
    return {"message": "Hello, FastAPI!"}  # 默认返回JSON响应
```
成功时刻：保存文件后，在终端运行 uvicorn main:app --reload。然后在浏览器中访问 http://127.0.0.1:8000/hello，你会看到一个JSON消息：{"message": "Hello, FastAPI!"}。恭喜！你已经创建了第一个Web API端点。

2. 什么是响应类？用生活化类比解释

在Web开发中，当客户端（比如浏览器）发送一个请求时，服务器需要返回一个响应。响应类定义了响应的格式，就像快递员要决定送信件还是包裹。

JSONResponse：好比发送一个标准的信件。它包含结构化的数据，以JSON格式呈现，易于机器阅读，例如API数据交换。
HTMLResponse：好比发送一个精美的网页。它包含HTML代码，浏览器可以渲染成漂亮的页面，用于显示内容给用户。

FastAPI内置了这些响应类，你可以直接使用，让快递员帮你打包好数据格式。

3. 使用JSONResponse：发送标准信件

默认情况下，FastAPI会自动将返回的字典转换为JSONResponse。但如果你想更明确地控制，可以自定义。

示例代码：修改 main.py，添加一个新的端点。

from fastapi import FastAPI
from fastapi.responses import JSONResponse  # 导入JSONResponse

app = FastAPI()

@app.get("/data")
def get_data():
    data = {"name": "Alice", "age": 30}
    return JSONResponse(content=data)  # 显式使用JSONResponse

成功时刻：重启服务器（如果已运行，由于--reload会自动重启），访问 http://127.0.0.1:8000/data。你会看到JSON响应：{"name": "Alice", "age": 30}。这说明你已经成功自定义了JSON响应！

4. 使用HTMLResponse：发送精美网页

有时，你想返回一个网页而不是纯数据。这时可以使用HTMLResponse。

示例代码：在 main.py 中添加另一个端点。

from fastapi import FastAPI
from fastapi.responses import HTMLResponse  # 导入HTMLResponse

app = FastAPI()

@app.get("/welcome", response_class=HTMLResponse)  # 指定响应类为HTMLResponse
def welcome_page():
    html_content = """
    <html>
        <body>
            <h1>Welcome to My FastAPI App!</h1>
            <p>This is a custom HTML page.</p>
        </body>
    </html>
    """
    return html_content  # 返回HTML字符串，FastAPI自动用HTMLResponse包装

成功时刻：访问 http://127.0.0.1:8000/welcome。你会看到一个简单的HTML页面显示“Welcome to My FastAPI App!”和一段文字。这是你的第一个自定义网页响应，是不是很有成就感？

5. 动手实践：混合使用响应类

现在，让我们尝试一个更实际的例子，结合两种响应类。

练习：创建一个应用，根据请求返回不同类型的响应。

步骤：修改 main.py，添加以下代码。

from fastapi import FastAPI
from fastapi.responses import JSONResponse, HTMLResponse

app = FastAPI()

@app.get("/info/{type}")
def get_info(type: str):
    if type == "json":
        data = {"info": "This is JSON data."}
        return JSONResponse(content=data)
    elif type == "html":
        html_content = "<html><body><h2>This is HTML content.</h2></body></html>"
        return HTMLResponse(content=html_content)
    else:
        return {"error": "Invalid type. Use 'json' or 'html'."}

成功时刻：运行应用后，尝试访问 http://127.0.0.1:8000/info/json 和 http://127.0.0.1:8000/info/html。你会看到JSON和HTML响应分别显示。通过这个实践，你已经掌握了如何根据需求自定义响应，Web开发的大门已经打开！

6. 总结与下一步

通过本教程，你学会了：

安装FastAPI并创建简单应用。
理解响应类的概念（JSONResponse像信件，HTMLResponse像网页）。
使用JSONResponse和HTMLResponse自定义响应，看到即时成功。

FastAPI还有很多强大功能等待探索，比如处理表单、数据库集成等。建议多动手实践，参考官方文档或在线教程。记住，每个小成功都是建立信心的基石。祝你在Web开发旅程中愉快前进！

如果你有任何问题，尝试修改代码或搜索FastAPI社区资源。现在，去创造更多有趣的API吧！

上一章 4.2 响应状态码与响应头

下一章 4.4 文件响应：FileResponse