FastAPI中如何声明非JSON响应的媒体类型?

fastapi中如何声明非json响应的媒体类型?

fastapi中的media_type声明

在fastapi中,当返回非json响应时,如图像流,声明media_type以告知客户端响应类型非常重要。

对于常规的json响应,响应头中的content-type会自动告诉客户端响应类型。然而,对于自定义响应类型,如图像流,必须声明媒体类型。

要指定media_type,可以使用response_class参数。response_class是一个自定义的流式响应类。

以下是一个示例,展示了如何为图像流自定义response_class以及如何使用它:

from fastapi import FastAPIfrom fastapi.responses import StreamingResponseapp = FastAPI()class MyCustomResponse(StreamingResponse):    media_type = "image/jpeg" # 在此处指定文件类型@app.get("/img", response_class=MyCustomResponse)def image():    def iterfile():        with open("./image.jpg", mode="rb") as file_like:            yield from file_like    return MyCustomResponse(iterfile())

登录后复制

通过使用自定义的mycustomresponse类,可以将media_type指定为image/jpeg。这将告知客户端响应是一个jpeg图像。

这样配置后,访问/docs时,api文档将显示该端点的响应类型为image/jpeg,明确告知外部消费端该端点的返回类型。

以上就是FastAPI中如何声明非JSON响应的媒体类型?的详细内容,更多请关注【创想鸟】其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至253000106@qq.com举报,一经查实,本站将立刻删除。

发布者:PHP中文网,转转请注明出处:https://www.chuangxiangniao.com/p/2178940.html

(0)
上一篇 2025年2月25日 13:54:53
下一篇 2025年2月25日 13:55:09

AD推荐 黄金广告位招租... 更多推荐

相关推荐

发表回复

登录后才能评论