FastAPI 学习之路(四十一)定制返回Response

接口中返回xml格式内容

from fastapi import FastAPI, Response

app = FastAPI()


# ① xml
@app.get("/legacy")
def get_legacy_data():
    data = """<?xml version="1.0"?>
        <shampoo>
        <Header>
            Apply shampoo here.
        </Header>
        <Body>
            You'll have to use soap here.
        </Body>
        </shampoo>
        """
    return Response(content=data, media_type="application/xml")

我们看下实际返回:

返回的类型是xml格式的,说明返回成功。

接口返回中定制headers

@app.get("/legacy_with_headers")
def get_legacy_with_headers_data():
    headers = {"X-Xtoken": "LC", "Content-Language": "en-US"}
    data = """<?xml version="1.0"?>
        <shampoo>
        <Header>
            Apply shampoo here.
        </Header>
        <Body>
            You'll have to use soap here.
            HERE SOMETHING HEADER YOU DEFINED
        </Body>
        </shampoo>
        """
    return Response(content=data, media_type="application/xml", headers=headers)

我们看下实际返回

对应的接口可以正常返回,对应的Headers返回正常。

设置cookie

@app.get("/legacy_with_header_cookie")
def legacy_with_header_cookie():
    headers = {"X-Xtoken": "LC-1", "Content-Language": "en-US"}
    data = """<?xml version="1.0"?>
            <shampoo>
            <Header>
                Apply shampoo here.
            </Header>
            <Body>
                You'll have to use soap here.
                HERE SOMETHING HEADER YOU DEFINED AND COOKIE
            </Body>
            </shampoo>
            """
    response = Response(content=data, media_type="application/xml", headers=headers)
    response.set_cookie(key="cookie_key_lc", value="mrli")
    return response

我们看下实际返回

接口可以正常返回我们设置的cookie,headers也可以正常返回。 

### 如何在 FastAPI 中创建一个通用的响应模型 在 FastAPI 中,可以通过定义一个统一的数据结构作为响应模型来简化代码逻辑并提高可维护性。这种做法不仅能够标准化 API 的返回格式,还能增强数据验证能力,并自动集成到 OpenAPI 文档中。 以下是基于提供的引用内容和专业知识设计的一个通用响应模型示例: #### 1. 定义通用响应模型 可以使用 Pydantic 提供的 `BaseModel` 类来定义一个标准的响应模型。该模型通常包含状态码、消息提示以及实际业务数据字段。 ```python from pydantic import BaseModel from typing import Any, Optional class ApiResponse(BaseModel): code: int = 0 # 状态码,默认为成功 message: str = "success" # 默认消息 data: Optional[Any] = None # 实际返回的数据部分 ``` 上述代码片段展示了如何定义一个基础的 `ApiResponse` 模型[^1]。其中: - **code**: 表示请求的状态码。 - **message**: 描述当前接口执行的结果情况。 - **data**: 存储具体的业务数据,支持任何类型的对象。 #### 2. 集成至路由处理器 当需要返回特定结果时,可以直接实例化这个类并将所需参数传递进去。 ```python from fastapi import FastAPI from .types.response import ApiResponse # 假设我们把前面定义好的模型放在此处 app = FastAPI() @app.get("/health", response_model=ApiResponse) async def health_check(): return ApiResponse(data={"status": "OK"}) ``` 这里设置了 `/health` 路径的操作函数,在其装饰器上指定了 `response_model=ApiResponse`[^2]。这样做的目的是让框架知道最终应该按照何种模式序列化输出的内容给客户端。 对于更加复杂的场景,则可能涉及错误处理等情况下的定制反馈信息: ```python @router.post("/submit-form", response_model=ApiResponse) async def submit_form(form_data: FormDataInput): try: processed_result = process_the_form(form_data) # 处理表单逻辑 if not valid_condition(processed_result): raise ValueError("Invalid form submission.") return ApiResponse(code=200, message="Form submitted successfully.", data=processed_result) except Exception as e: error_message = f"Failed to handle the request due to {str(e)}" return ApiResponse(code=400, message=error_message, data=None) ``` 以上例子说明了即使遇到异常状况也能优雅地给出恰当的回答形式[^3]。 #### 3. 使用 HttpResponse 或其他扩展方式 (高级选项)[^5] 如果项目规模较大或者存在特殊需求的话,还可以考虑进一步抽象出专门负责组装这些基本信息的服务层组件;甚至利用中间件捕获全局未被捕获的异常等等手段提升整体架构质量。 --- ### 总结 通过上述方法可以在 FastAPI 应用程序里轻松建立一套一致性的 RESTful API 输出样式。这有助于开发者快速定位问题所在之处的同时也便于前端解析服务器端传来的资料包体。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值