### 如何在Python API中自定义返回的数据格式和内容 #### 使用FastAPI实现通用返回结构 为了确保所有API响应遵循一致的格式，在FastAPI项目中可以利用Python注解类型以及Pydantic库来创建统一的返回结构[^1]。下面是一个简单的例子展示如何做到这一点： ```python from fastapi import FastAPI, HTTPException from pydantic import BaseModel from typing import TypeVar, Generic, Union T = TypeVar('T') class ApiResponse(Generic[T]): code: int message: str data: T app = FastAPI() @app.get("/items/{item_id}", response_model=ApiResponse[str]) async def read_item(item_id: int): if item_id not in items_db: raise HTTPException(status_code=404, detail="Item not found") content = {"code": 200, "message": "success", "data": f"Item {item_id}"} return ApiResponse(**content) ``` 在这个案例里，`ApiResponse` 是一个泛型类，它允许携带任意类型的 `data` 字段；当调用 `/items/{item_id}` 接口时会按照预设好的模板返回JSON对象。 #### 定义自定义数据类型 除了借助框架特性外，也可以基于需求构建特定的应用场景下的自定义数据类型[^2]。比如想要封装一种新的复合数据形式用于表示图书信息，则可以通过继承内置类型或者组合多个基本类型完成此类工作： ```python class BookInfo(dict): def __init__(self, title=None, author=None, isbn=None): super().__init__() self['title'] = title or '' self['author'] = author or [] self['isbn'] = isbn or '' book_data = { 'title': 'The Great Gatsby', 'author': ['F. Scott Fitzgerald'], 'isbn': '9780743273565' } new_book_info = BookInfo(**book_data) print(new_book_info) # 输出 {'title': 'The Great Gatsby', 'author': ['F. Scott Fitzgerald'], 'isbn': '9780743273565'} ``` 这里展示了怎样通过扩展字典类来自定义一个新的书籍信息存储方式——`BookInfo` 类既保留了原有字典的功能又增加了领域逻辑上的语义表达能力。 #### Flask中的异常处理与定制化错误消息 对于Flask这样的Web应用来说，合理设置HTTP状态码并提供清晰易懂的报错提示同样重要[^3]。如果希望改变默认情况下抛出的异常行为，那么可以在应用程序内部注册全局性的错误处理器函数来进行调整： ```python from flask import jsonify class InvalidUsage(Exception): status_code = 400 def __init__(self, message, status_code=None, payload=None): Exception.__init__(self) self.message = message if status_code is not None: self.status_code = status_code self.payload = payload def handle_invalid_usage(error): response = error.to_dict() response["status"] = "error" return jsonify(response), error.status_code @app.errorhandler(InvalidUsage) def invalid_usage_handler(error): return handle_invalid_usage(error) if __name__ == "__main__": app.run(debug=True) ``` 上述代码片段说明了如何捕捉由业务层触发的特殊异常情况，并将其转换成易于理解且符合RESTful风格的标准输出格式。