возникла ошибка атрибута при попытке документировать flask тело запроса restplus?

Question

Я пытаюсь задокументировать свое тело запроса с помощью Flask -restplus 'api.model, и я должен предоставить данные в определенной c структуре. Вот тело запроса выглядит так:

тело запроса

{
  "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 для вышеуказанного тела запроса и тела ответа? Любая идея, чтобы сделать это правильно? спасибо

Answer 1

В вашем коде не хватает нескольких вещей:

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)

См. документы для использования нескольких пространств имен и как создать и зарегистрируйте их.