Starlette设置响应状态码及响应头

星宇姑娘_5275

星宇姑娘_5275

2026-11-19

804人浏览

原创

在 starlette 中设置响应状态码和响应头,最直接的方式是实例化 starlette.responses.response 的子类(如 jsonresponse),并在构造函数中传入 status_code 参数以及通过 headers 字典传递自定义头部。这样做会生成一个包含指定 http 状态码和完整头部信息的响应对象,直接返回给 asgi 服务器即可生效。

Starlette设置响应状态码及响应头

如何创建带自定义头的 JSON 响应

要创建一个返回 JSON 数据并附带自定义响应头的接口,可以使用 JSONResponse 类。只需在初始化时提供 status_code 为期望的状态值(例如 201 或 404),并通过 headers 参数传入一个字典,其中键值对即为需要设置的头部信息。Starlette 会自动将这些头部合并到最终的 HTTP 响应中。

Starlette设置响应状态码及响应头

from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route

async def custom_json_response(request):
    # 定义自定义响应头
    headers = {
        "X-Custom-Header": "MyValue",
        "X-Request-ID": "12345"
    }
    
    # 创建响应,指定状态码和头部
    return JSONResponse(
        content={"message": "Success", "data": [1, 2, 3]},
        status_code=201,
        headers=headers
    )

app = Starlette(routes=[Route("/api/data", custom_json_response)])

上述代码定义了路由 /api/data。当请求该路径时,应用将返回状态码 201 Created,响应体为 JSON 格式,且包含 X-Custom-Header 和 X-Request-ID 两个自定义头部。这是处理结构化数据并需要精细控制元数据的标准做法。

如何修改已有响应的头部信息

如果已经生成了一个响应对象但需要追加或修改头部,可以直接操作响应对象的 headers 属性。这是一个 Headers 对象,支持类似字典的赋值操作。你可以先创建基础响应,然后通过 response.headers["Key"] = "Value" 的方式动态添加或覆盖特定头部,最后再返回该对象。这种方式适用于需要在业务逻辑中间件或装饰器中注入额外信息的场景。

HTTP状态码查询
HTTP状态码查询

查询网站的HTTP响应状态码,判断网站是否正常访问、是否重定向、是否存在错误。适用于"HTTP状态码查询""网站状态查询""HTTP状态检测""网页状态码""网站响应码""301重定向查询"等请求。通过本地 Python 脚本调用网站HTTP状态查询接口,并使用环境变量中的专属 API Key。

下载

Starlette设置响应状态码及响应头

from starlette.applications import Starlette
from starlette.responses import PlainTextResponse
from starlette.routing import Route

async def modify_headers(request):
    # 先创建一个基础响应
    response = PlainTextResponse(content="Hello World", status_code=200)
    
    # 动态添加或修改头部
    response.headers["Cache-Control"] = "no-cache"
    response.headers["X-Powered-By"] = "Starlette"
    
    # 返回修改后的响应
    return response

app = Starlette(routes=[Route("/text", modify_headers)])

在 /text 路由中,程序首先创建一个普通的文本响应。随后,代码显式地向 response.headers 字典中写入了 Cache-Control 和 X-Powered-By。这种写法允许开发者在响应构建完成后,根据运行时条件灵活调整头部内容,而不必在初始构造时就确定所有细节。

使用 Response 基类设置通用状态码与头部

除了特定的子类,还可以直接使用 starlette.responses.Response 基类来设置状态码和头部。这在需要返回非标准 MIME 类型或纯文本、二进制流等场景下非常有用。通过实例化 Response 并传入 status_code 和 headers,可以完全控制 HTTP 响应的元数据部分。需要注意的是,基类通常要求提供 content 参数,且默认 Content-Type 可能为空或需手动指定。

from starlette.applications import Starlette
from starlette.responses import Response
from starlette.routing import Route

async def generic_response(request):
    headers = {
        "Content-Type": "application/octet-stream",
        "X-Custom-Generic": "True"
    }
    
    return Response(
        content=b"Binary data or raw text",
        status_code=200,
        headers=headers
    )

app = Starlette(routes=[Route("/generic", generic_response)])

此示例展示了如何使用基类 Response。它明确设置了 Content-Type 为 application/octet-stream,并添加了 X-Custom-Generic 头部。返回的内容是字节串。这种灵活性使得开发者可以处理各种非 JSON 或非 HTML 的响应场景,同时保持对状态码和头部的精确控制。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1951

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5564

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1889

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

34017

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3987

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3987

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1283

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

636

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3103

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程