J'essaie de créer une API avec Flask-RestX qui peut afficher une réponse comme celle-ci,

{
  "id": 1,
  "msg": "How are things",
  "score": 345,
  "additional": {
    "goal": 56,
    "title": "ASking how"
  }
}

Quand les données sont comme ça (dans mon cas, je ne contrôle pas le format des données),

data = {
    "id":1,
    "msg":"How are things",
    "goal": 56,
    "score":345,
    "title":"Asking how"
}

Mais la réponse que j'obtiens avec le code actuel est fausse, elle affiche des valeurs nulles

{
  "id": 1,
  "msg": "How are things",
  "score": 345,
  "additional": {
    "goal": null,
    "title": null
  }
}

Code complet -

from flask import Flask
from flask_restx import Resource, Api, fields

app = Flask(__name__)
api = Api(app)

data = {
    "id":1,
    "msg":"How are things",
    "goal": 56,
    "score":345,
    "title":"Asking how"
}

extra = api.model('Extra', {
    'goal': fields.Integer,
    'title': fields.String
    })

model = api.model('Model', {
    'id' : fields.Integer,
    'msg' : fields.String,
    'score': fields.Integer,
    'additional' : fields.Nested(extra)
  })


@api.route('/hello')
class HelloWorld(Resource):
    @api.marshal_with(model)
    def get(self):
        return data

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

Je suis complètement nouveau sur Flask-RestX / Flask-RestPlus. Dites-moi, comment puis-je y parvenir sans changer le format des données lui-même.

1
realsdx 9 févr. 2021 à 20:13

1 réponse

Meilleure réponse

Conformément au commentaire de waynetech ci-dessus, ce qui suit a fonctionné pour moi:

from flask import Flask
from flask_restx import Resource, Api, fields

app = Flask(__name__)
api = Api(app)

data = {
    "id":1,
    "msg":"How are things",
    "score":345,
    "additional": {
        "goal": 56,
        "title": "Asking how",
    }
}

extra = api.model('Extra', {
    'goal': fields.Integer,
    'title': fields.String
    })

model = api.model('Model', {
    'id' : fields.Integer,
    'msg' : fields.String,
    'score': fields.Integer,
    'additional' : fields.Nested(extra)
  })


@api.route('/hello')
class HelloWorld(Resource):

    @api.marshal_with(model)
    def get(self):
        return data

    @api.marshal_with(model)
    def post(self):
        data = api.payload

        return data

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

Voici le script de test rapide que j'ai utilisé:

from pprint import pprint
import requests

payload = {
    "id": 1,
    "msg":"Test",
    "score":345,
    "additional": {
        "goal": 56,
        "title": "Test",
    }
}

url = 'http://127.0.0.1:4000/hello'
r = requests.post(url, json=payload)

if r.status_code == 200:
    print(r.status_code)
    pprint(r.json())
else:
    print("FAIL: ", r.status_code)
1
Danny Blaker 8 mars 2021 à 06:11