docs 里的 media_type 是通过 response_class 实现的,需要自定义 response_class 才能修改。 from fastapi import FastAPI from fastapi.responses import StreamingResponse app = FastAPI() class MyCustomResponse(StreamingResponse): media_type = "image/jpeg" # 将文件类型写在这里 @app.get("/img", response...
asyncdefread_item(item_id: str, img: Optional[bool] =None):ifimg:returnFileResponse("image.png", media_type="image/png")else:return{"id":"foo","value":"there goes my hero"}
</shampoo>"""returnResponse(content=data, media_type="application/xml") 我们可以在路径操作装饰器中声明要返回的具体Response类型,返回的内容会被放入到指定的Response中。 并且如果我们指定的Response支持JSON media类型,例如JSONResponse或者UJSONResponse,那么返回的数据就会被自动转换成Pydantic模型(通过response_mode...
上面的栗子中,Response Header 的 Content-type 将为 text/html,并且会记录在 OpenAPI 中 查看Swagger API 文档的 Response Header 请求结果 源码 只是声明了下 media_type,其他都没变 返回自定义 Response 的第二种方式 背景 上面的两个栗子是通过在路径操作装饰器的 response_class 来声明 Response @app.get("...
Response类接受如下参数: content- 一个str或者bytes。 status_code- 一个int类型的 HTTP 状态码。 headers- 一个由字符串组成的dict。 media_type- 一个给出媒体类型的str,比如"text/html"。 说明 当你直接返回Response时,它的数据既没有校验,又不会进行转换(序列化),也不会自动生成文档。
app=FastAPI()@app.get("/",response_class=PlainTextResponse)asyncdefmain():return"Hello World" 查看Swagger API 文档的 Response Header 默认是 application/json,现在改成了 text/plain 请求结果 源码 只是声明了下 media_type,其他都没变 假如直接 return 字符串,Content-type 默认会是什么类型?
media_type: 响应的媒体类型,默认为None,会根据内容自动推断合适的媒体类型。 background: 是否在后台运行响应处理函数,默认为None,表示由FastAPI框架自动决定。 使用fastapi.Response()可以方便地构建自定义的响应,适用于一些特殊的场景需求,例如需要返回非JSON格式的响应内容,或者需要自定义特定的标头信息。
上面的栗子中,Response Header 的 Content-type 将为 text/html,并且会记录在 OpenAPI 中 查看Swagger API 文档的 Response Header 请求结果 只是声明了下 media_type,其他都没变 返回自定义 Response 的第二种方式 背景 上面的两个栗子是通过在路径操作装饰器的 response_class 来声明 Response@app.get("/items...
import uvicornfrom fastapi import FastAPI, Responseapp = FastAPI()@app.get("/legacy/")def get_legacy_data():data = """<?xml ve rsion="1.0"?><shampoo><Header>Apply shampoo here.</Header><Body>You'll have to use soap here.</Body></shampoo>"""# 重点就是指定 media_typereturn Respo...
返回fastapi.responses.Response 以及您的自定义 content 和media_type。 您还需要处理端点装饰器以使 FastAPI 将正确的媒体类型放入 OpenAPI 规范中。 @app.get( "/image", # Set what the media type will be in the autogenerated OpenAPI specification. # fastapi.tiangolo.com/advanced/additional-responses/#...