flask restful:如何用字段记录响应体.Dict()



flask-restplus中,我想对具有嵌套列表结构的响应体进行建模,因此无论何时调用api,都会返回我所期望的响应体。在response body中,它有一个嵌套结构,我不知道如何记录它。我要用fields.Dict()吗?有人能在这里告诉我如何在flask-restplus中实现这一点吗?

响应体

{
"score": 0,
"category": "low",
"guidance": "string",
"is_ready": true,
"used_features": [
{
"name": "hear_rate",
"value": 1002,
"range_value": [
10,
1000,
10000,
20000
],
"range_frequency": [
80,
15,
2,
1
],
"importance": 1
},
{
"name": "pressure",
"value": 400,
"range_value": [
10,
1000,
3000
],
"range_frequency": [
85,
10,
5
],
"importance": 2
}
]
}

我的部分解决方案

这是我的部分解决方案

from flask import Flask, jsonify
from flask_restplus import Api, Resource, fields, reqparse, inputs
app = Flask(__name__)
api = Api(app)
ns = api.namespace('ns')
payload = api.model('Payload', {
'score': fields.Integer,
'category': fields.String,
'guidance': fields.String,
'is_ready': fields.Boolean,
## how to add used features arrays
})

@ns.route('/')
class AResource(Resource):
@ns.expect(payload)
def get(self):
parser = reqparse.RequestParser()
parser.add_argument('score', type=str, required=True)
parser.add_argument('category', type=str, required=True)
parser.add_argument('guidance', type=str, required=True)
parser.add_argument('category', type=str, required=True)
parser.add_argument('is_ready', type= bool, required=True)
try:  # Will raise an error if date can't be parsed.
args = parser.parse_args()  # type "dict"
return jsonify(args)
except:
return None, 400
if __name__ == '__main__':
app.run(debug=True)

在我尝试的代码中,我无法想出如何为used_features字典建模的解决方案。有什么方法可以修复上述尝试的缺陷吗?有人能告诉我如何正确地建模响应体吗?我要在代码中使用Dict还是Nested?还有其他想法吗?感谢

使用@ns.marchir_with(有效载荷(

decorator marche_with((实际获取数据对象并应用字段筛选。编组可以处理单个对象、dict或对象列表。编组资源链接:https://flaskrestplus.readthedocs.io/en/stable/marshalling.html

要建模used_features,请使用字段。嵌套。我已经在下面的代码中展示了如何使用它。


from flask import Flask, jsonify
from flask_restplus import Namespace, Resource, fields, reqparse
from flask_restplus import Api
app = Flask(__name__)
api = Api(app)
ns = api.namespace('ns')

used_features = {}
used_features['name'] = fields.String(attribute='name')
used_features['value'] = fields.Integer(attribute='value')
used_features['range_value'] = fields.List(
fields.Integer, attribute='range_value')
used_features['range_frequency'] = fields.List(
fields.Integer, attribute='range_frequency')
used_features['importance'] = fields.Integer(attribute='importance')
used_features_payload = api.model('feature_payload', used_features)
payload = api.model('Payload', {
'score': fields.Integer,
'category': fields.String,
'guidance': fields.String,
'is_ready': fields.Boolean,
'used_features': fields.Nested(used_features_payload)
# how to add used features arrays
})

@ns.route('/')
class AResource(Resource):
@ns.expect(payload)
@ns.marshal_with(payload)
def get(self):
parser = reqparse.RequestParser()
parser.add_argument('score', type=str, required=True)
parser.add_argument('category', type=str, required=True)
parser.add_argument('guidance', type=str, required=True)
parser.add_argument('category', type=str, required=True)
parser.add_argument('is_ready', type=bool, required=True)
try:  # Will raise an error if date can't be parsed.
args = parser.parse_args()  # type "dict"
return jsonify(args)
except:
return None, 400

if __name__ == '__main__':
app.run(debug=True, port=1234)

https://flask-restplus.readthedocs.io/en/stable/marshalling.html

from flask_restplus import fields, Namespace, marshal
api = Namespace("Student data")
db_data = Student_details.query.all()
data_marshal_obj = api.model(" Data", {
"id": fields.String(),
"number": fields.Integer(),
"house_name": fields.String(),
})
return {'id': str(student.id),"page_data": marshal(db_data, data_marshal_obj)}

flask restpluse中的定制响应编组