关于flask-restx的API响应的Swagger文档

Question

我正在阅读有关flask-restx的swagger文档的文档，并遵循示例。我明白，为了为API接受的参数生成swagger文档，我应该执行

@api.doc(params={'id': 'An ID'})

但是，我找不到如何记录API响应体的解释。不是响应代码，而是get方法返回的结果。我要找的是像下面这样的东西:

class MyResource(Resource):
@api.doc(returns={"info": "Some very interesting information"})
def get(self, id):
res = some_function_of_id(id)
return {"info": res}

谁知道这是可能的，如果是，如何?

Answer 1

尝试api。反应修饰符

model = api.model('Model', {
'name': fields.String,
})
@api.route('/my-resource/')
class MyResource(Resource):
@api.response(200, 'Success', model)
@api.response(400, 'Validation Error')
def get(self):
pass

注意，@api.marshal_with()装饰器会自动记录响应。

https://flask-restx.readthedocs.io/en/latest/swagger.html documenting-with-the-api-response-decorator