python flask 设置 header 响应体、响应头、状态码

电玩女神 2021-08-29 11:32 1627阅读 0赞

### 需求场景 ###

在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)

使用浏览器请求如下：

![13423234-4eceb686e6dd73c1.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)

使用浏览器请求如下：

![13423234-910bafc295d0de6d.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)

使用浏览器请求如下：

![13423234-aabcc302dd65f903.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)

在浏览器执行如下：

![13423234-2bce353b5626df46.png][]

[13423234-4eceb686e6dd73c1.png]: /images/20210728/01174fbd2d024f4284b7718fb651fba4.png
[13423234-910bafc295d0de6d.png]: /images/20210728/e2be803e4b8149cf8073f56159e27824.png
[13423234-aabcc302dd65f903.png]: /images/20210728/ca9745653fea4dbaa0e6f2fa4e12286e.png
[13423234-2bce353b5626df46.png]: /images/20210728/87b52f7ad9cc4e2e96c63dbb869f716b.png