FastAPI里怎样自定义Swagger响应的媒体类型

在使用FastAPI构建API时，Swagger作为强大的API文档工具，能直观展示API的各种信息，包括请求与响应。默认情况下，Swagger提供了一些常见的响应媒体类型，但在实际项目中，我们往往需要自定义响应媒体类型以满足特殊需求。

要明确自定义Swagger响应媒体类型的重要性。比如，在处理特定格式的数据，如XML或者一些自定义二进制格式时，默认的JSON媒体类型无法满足要求。通过自定义，我们可以让API更加灵活和适配各种应用场景。

在FastAPI中实现这一功能并不复杂。我们可以利用FastAPI提供的APIRouter和Response类来进行操作。假设我们要添加一个自定义的XML媒体类型响应。

先安装xmltodict库，这将帮助我们将Python字典转换为XML格式。示例代码如下：

from fastapi import FastAPI, Response
import xmltodict

app = FastAPI()

@app.get("/xml_response", response_class=Response)
async def xml_response():
    data = {"message": "这是一个自定义的XML响应"}
    xml_data = xmltodict.unparse(data)
    return Response(content=xml_data, media_type="application/xml")

在上述代码中，我们定义了一个路径操作函数xml_response，通过Response类返回自定义的XML数据，并指定媒体类型为application/xml。

如果要让Swagger正确显示这个自定义的媒体类型响应，还需要一些额外配置。可以使用OpenAPI的openapi属性来调整文档设置。例如：

from fastapi.openapi.utils import get_openapi

def custom_openapi():
    if app.openapi_schema:
        return app.openapi_schema
    openapi_schema = get_openapi(
        title="自定义Swagger响应媒体类型示例",
        version="1.0",
        routes=app.routes
    )
    openapi_schema["components"]["schemas"] = {}
    app.openapi_schema = openapi_schema
    return app.openapi_schema

app.openapi = custom_openapi

这样，Swagger文档就能正确识别并展示我们自定义的XML媒体类型响应。

通过这些步骤，我们在FastAPI里成功自定义了Swagger响应的媒体类型，使API在文档展示和数据交互方面都更加符合实际需求，为开发者和使用者带来极大便利，也提升了整个项目的质量和可维护性。