flask restful:如何使用fields.Dict()记录响应正文? [英] flask restful: how to document response body with fields.Dict()?
问题描述
在flask-restplus
中,我想对具有嵌套列表结构的响应主体进行建模,因此每当进行api调用时,响应主体都会返回我期望的结果.在响应主体中,它具有嵌套结构,我不知道该如何记录.我要使用fields.Dict()
吗?有人可以在这里指出我如何在flask-restplus
中实现这一目标吗?
In flask-restplus
, I want to model the response body which has nested list strucure, so whenever make api call, response body will be returned what I expected. In responce body, it has a nested structure, I don't know how to document that. Am I gonna use fields.Dict()
? can anyone point me out here how to make this happen in 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
吗?还有什么想法吗?谢谢
in my attempted code, I couldn't come up with a solution of how to model used_features
dictionary. Is there any way to fix the defect of above attempt? can anyone point me out how to make this work where I can model the response body correctly? Am I gonna use Dict
or Nested
in my code? any further thought? thanks
推荐答案
使用 @ ns.marshal_with(有效载荷).
装饰器marshal_with()实际上是获取数据对象并应用字段过滤的东西.编组可以对单个对象,字典或对象列表进行处理. 编组资源链接: https://flaskrestplus.readthedocs.io/en/stable/marshalling. html
The decorator marshal_with() is what actually takes your data object and applies the field filtering. The marshalling can work on single objects, dicts, or lists of objects. Marshalling Resource Link: https://flaskrestplus.readthedocs.io/en/stable/marshalling.html
要建模 used_features ,请使用fields.Nested.我已经在下面的代码中展示了如何使用它.
And to model used_features use fields.Nested. I have shown how to use it in the following code.
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)
这篇关于flask restful:如何使用fields.Dict()记录响应正文?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!