[flask]统一API响应格式

卢晓阳

前言

在设计API返回内容时，通常需要与前端约定好API返回响应体内容的格式。这样方便前端进行数据反序列化时相应的解析处理，也方便其它服务调用。不同公司有不同的响应内容规范要求，这里以常见的JSON响应体为例：

1. {
2.     "code": 200,
3.     "data": {
4.         "content": "this is /a/1"
5.     },
6.     "msg": "success"
7. }

复制代码

code字段

code状态码主要用于表示错误类型区间状态码。如果设计比较简单，可以直接使用HTTP的状态码。如果是一个大型系统，也可以设计一套自定义的状态码。比如：

1. from enum import Enum
3. class BizStatus(Enum):
4.     # custom status code
5.     OK = 200
6.     BadRequestA1 = 4001  # 请求参数异常-A情况
7.     BadRequestA2 = 4002  # 请求参数异常-B情况

复制代码

message字段

message 字段是对当前 code 状态码错误明细的补充说明。通常不同的code状态码会有不同的message描述信息。
data字段

data 值通常代表返回的响应体内容。
示例代码

以下代码定义了一个JSON响应类，api在返回的时候需要引用这个响应类。除此之外，还对404和一般异常做了统一处理，当出现这两类异常时，也会返回JSON结构的响应体。

1. from flask import Flask, request, jsonify, make_response
2. from http import HTTPStatus
4. API_KEY_SVCA = "flask_unify_response"
6. app = Flask(__name__)
9. class JsonResponse:
10.     """A class to represent a JSON response."""
11.     def __init__(
12.         self, code: HTTPStatus = HTTPStatus.OK, msg: str = "success", data=None
13.     ):
14.         self.code = code
15.         self.msg = msg
16.         self.data = data
18.     def to_dict(self):
19.         return {
20.             "code": self.code.value,
21.             "msg": self.msg,
22.             "data": self.data,
23.         }
25.     def to_json(self):
26.         return jsonify(self.to_dict())
28.     def response(self):
29.         response = make_response(self.to_json(), self.code.value)
30.         response.headers["Content-Type"] = "application/json"
31.         return response
34. @app.errorhandler(404)
35. def error_handler_not_found(error):
36.     req_method = request.method
37.     req_path = request.path
38.     return JsonResponse(
39.         code=HTTPStatus.NOT_FOUND,
40.         msg=f"{req_method} {req_path} Not Found",
41.     ).response()
44. @app.errorhandler(Exception)
45. def error_handler_generic(error):
46.     req_method = request.method
47.     req_path = request.path
48.     return JsonResponse(
49.         code=HTTPStatus.INTERNAL_SERVER_ERROR,
50.         msg=f"Internal Server Error. {req_method} {req_path}",
51.         data={"error": str(error)},
52.     ).response()
55. @app.get("/a/1")
56. def apitest_a1():
57.     return JsonResponse(
58.         code=HTTPStatus.OK, msg="success", data={"content": "this is /a/1"}
59.     ).response()
62. @app.get("/a/2")
63. def apitest_a2():
64.     raise Exception("exception in a/2")
67. if __name__ == "__main__":
68.     app.run(host="127.0.0.1", port=8001)

复制代码

客户端请求测试:

1. $ curl -s http://127.0.0.1:8001/a/1 | python3 -m json.tool{
2.     "code": 200,
3.     "data": {
4.         "content": "this is /a/1"
5.     },
6.     "msg": "success"
7. }$ curl -s http://127.0.0.1:8001/a/2 | python3 -m json.tool{    "code": 500,    "data": {        "error": "exception in a/2"    },    "msg": "Internal Server Error. GET /a/2"}$ curl -s http://127.0.0.1:8001/a/3 | python3 -m json.tool{    "code": 404,    "data": null,    "msg": "GET /a/3 Not Found"}

复制代码

来源:https://www.cnblogs.com/XY-Heruo/p/18257354
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！