Swagger留档用于使用flask-rest x进行API响应

Question

我正在阅读使用flask-rest x的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.response设计师

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