python flask 设置个性化的响应体响应头状态码

迈不过友情╰ 2021-09-03 09:10 439阅读 0赞

**目录**

需求场景

使用return直接设置特定的响应信息

使用make\_response设置特定的响应信息

--------------------

### 需求场景 ###

在api设计中，基于restful的设计原则，一个http的响应应该包含执行的响应信息以及状态码。

例如：一个错误信息的响应信息应该包含内容以及返回对应的设计错误码。

在flask中如何制定这个的响应信息呢？下面来看看。

### 使用return直接设置特定的响应信息 ###

> return 响应体, 状态码, 响应头  
> 等价于  
> return (响应体, 状态码, 响应头)

return 可以返回一个元组，这样的元组必须是 (response, status, headers) 的形式，且至少包含一个元素。 status 值会覆盖状态代码， headers 可以是一个列表或字典，作为额外的消息标头值。

下面写个示例视图函数如下：

from flask import Flask, request, abort
    
    # 实例化app
    app = Flask(import_name=__name__)
    
    @app.route('/login', methods=["GET","POST"])
    def login():
    
        # return 响应体, 状态码, 响应头
        return "login fail", 404, [("token", "123456"), ("City", "shenzhen")] # 使用元组的方式设置header
    
    if __name__ == '__main__':
        app.run(debug=True)

使用浏览器请求如下：

![bd44d86028e36fcfb5dfdd683f0f9210.png][]

return "login fail", 404, [("token", "123456"), ("City", "shenzhen")]

可以看到上面设置响应消息成功返回。

status 值可以设置任意的状态代码，headers可以是字典

from flask import Flask, request, abort
    
    # 实例化app
    app = Flask(import_name=__name__)
    
    @app.route('/login', methods=["GET","POST"])
    def login():
    
        # return 响应体, 状态码, 响应头
        # return "login fail", 404, [("token", "123456"), ("City", "shenzhen")] # 使用元组的方式设置header
        return "login fail", "666 hello wolrd", {"token":"123456", "City": "shenzhen"} # 使用元组的方式设置header
    
    if __name__ == '__main__':
        app.run(debug=True)

使用浏览器请求如下：

![e273cb720629d14e69ab55e5a99a4f27.png][]

响应消息元组 (response, status, headers) 至少包含一个元素

from flask import Flask, request, abort
    
    # 实例化app
    app = Flask(import_name=__name__)
    
    @app.route('/login', methods=["GET","POST"])
    def login():
    
        # return 响应体, 状态码, 响应头
        # return "login fail", 404, [("token", "123456"), ("City", "shenzhen")] # 使用元组的方式设置header
        # return "login fail", "666 hello wolrd", {"token":"123456", "City": "shenzhen"} # 使用元组的方式设置header
        return "login fail", "999 hello wolrd"
    
    if __name__ == '__main__':
        app.run(debug=True)

使用浏览器请求如下：

![81833c87d7fb4c381400eeb6e84187d9.png][]

可以看到只要至少有一项作为响应消息即可。

除了return的方式返回特性的响应消息，还可以使用另一种方式。

### 使用make\_response设置特定的响应信息 ###

导入make\_response

from flask import make_response

示例代码如下：

from flask import Flask, request, abort, make_response
    
    # 实例化app
    app = Flask(import_name=__name__)
    
    @app.route('/login', methods=["GET","POST"])
    def login():
    
        res = make_response("login fail") # 设置响应体
        res.status = '999 login fail' # 设置状态码
        res.headers['token'] = "123456" # 设置响应头
        res.headers['City'] = "shenzhen" # 设置响应头
    
        return res
    
    if __name__ == '__main__':
        app.run(debug=True)

在浏览器执行如下：

![1fd994a1ffd8c7e34fffcbb376d663de.png][]

[bd44d86028e36fcfb5dfdd683f0f9210.png]: /images/20210728/e1f6cb84547a4925ac9dd4b319f4e3bf.png
[e273cb720629d14e69ab55e5a99a4f27.png]: /images/20210728/b7262d3e842b4b3684c48f48122badf5.png
[81833c87d7fb4c381400eeb6e84187d9.png]: /images/20210728/3a4e444f68bc4efe9051c2fa8ee8cb88.png
[1fd994a1ffd8c7e34fffcbb376d663de.png]: /images/20210728/161b50d5a5cb4cbdbaaa05022f894db8.png