我正在尝试用Flask-restplus'api.model
来记录我的请求正文,并且我必须以特定的结构提供数据。请求正文如下:
请求正文
{
"version": 0,
"subject": "SUBJECT10",
"organization": "company",
"time": "2010-02-10T09:30:00Z",
"features": {
"age": 18,
"gender": "M",
"hear_rate": {
"value": 120,
"time": "2010-02-10T09:30:00Z"
},
"blood pressure": {
"value": 72,
"time": "2012-02-10T09:30:00Z"
},
"wbc": {
"value": 10,
"time": "2010-02-10T09:30:00Z"
}
}
}
我的尝试:
为了将请求主体建模为Flask-Restplus'api.model
,我提出了以下引发属性错误的解决方案。
from flask_restplus import fields
from flask import Flask, jsonify
from flask_restplus import Api, Resource, fields, reqparse, inputs
app = Flask(__name__)
api = Api(app)
ns = api.namespace('test api')
features_attr = api.model('features', {
# 'name': fields.String(required=True),
'value': fields.Integer(required=True),
'time': fields.Date(required=True)
})
class feats_objs(fields.Nested):
__schema_type__ = ['string', 'object']
def output(self, key, obj):
if key =='value':
return obj
else:
return 'default value'
return super().output(key, obj)
def schema(self):
schema_dict = super().schema()
schema_dict.pop('type')
nested_ref = schema_dict.pop('$ref')
schema_dict['oneof'] = [
{'type': 'string'},
{'$ref': nested_ref}
]
return schema_dict
feat_root_objs = api.model('feats_root_objs', {
'age': fields.String(required=True),
'gender': fields.String(required=True),
'time': fields.Date(required=True),
'features': fields.List(fields.biom_feats_objs(features_attr))
})
@ns.route('/my_features')
class my_features(Resource):
@ns.expect(feat_root_objs)
def post(self):
parser = reqparse.RequestParser()
parser.add_argument('age', type=str, required=True),
parser.add_argument('gender', type=str, required=True),
parser.add_argument('features', type=str, required=True),
parser.add_argument('time', type=inputs.datetime_from_iso8601, required=True)
try:
args = parser.parse_args()
return jsonify(args)
except:
return None, 400
if __name__ == '__main__':
app.run(debug=True)
错误消息:
这是我从上面的代码中得到的错误消息。
Traceback (most recent call last):
File ".\my_features.py", line 41, in <module>
'features': fields.List(fields.feats_objs(features_attr))
AttributeError: module 'flask_restplus.fields' has no attribute 'feats_objs'
但是上面的代码给了我属性错误,我不知道为什么上面的代码无法编译。我该如何工作?如何为以上请求正文和响应正文正确设置api.model
?有什么办法解决这个问题吗?谢谢
答案 0 :(得分:2)
您的代码中缺少一些东西:
1)从Namespace
导入flask_restfulplus
对象
2)使用Namespace
对象创建名称空间
3)向API注册名称空间
请参阅修改后的代码段:
from flask_restplus import fields
from flask import Flask, jsonify
from flask_restplus import Api, Namespace, Resource, fields, reqparse, inputs
# 1) import `Namespace` above
app = Flask(__name__)
api = Api(app)
ns = Namespace('test api') # 2) create the namespace 'test api'
features_attr = api.model('biomarker features', {
# 'name': fields.String(required=True),
'value': fields.Integer(required=True),
'time': fields.Date(required=True)
})
class biom_feats_objs(fields.Nested):
__schema_type__ = ['string', 'object']
def output(self, key, obj):
if key =='value':
return obj
else:
return 'default value'
return super().output(key, obj)
def schema(self):
schema_dict = super().schema()
schema_dict.pop('type')
nested_ref = schema_dict.pop('$ref')
schema_dict['oneof'] = [
{'type': 'string'},
{'$ref': nested_ref}
]
return schema_dict
feat_root_objs = api.model('biom_feats_root_objs', {
'age': fields.String(required=True),
'gender': fields.String(required=True),
'time': fields.Date(required=True),
'features': fields.List(fields.Nested(features_attr))
})
@ns.route('/immunomatch_Ed_features')
class immunomatch_Ed_features(Resource):
@ns.expect(feat_root_objs)
def post(self):
parser = reqparse.RequestParser()
parser.add_argument('age', type=str, required=True),
parser.add_argument('gender', type=str, required=True),
parser.add_argument('features', type=str, required=True),
parser.add_argument('time', type=inputs.datetime_from_iso8601, required=True)
try:
args = parser.parse_args()
return jsonify(args)
except:
return None, 400
if __name__ == '__main__':
api.add_namespace(ns) # 3) register your namespace with your api
app.run(debug=True)
有关使用多个名称空间以及如何创建和注册它们的信息,请参见docs。