Python Flask RESTPlus是否支持OpenAPI响应示例属性?
给定一个RESTPlus模型,如:Python Flask RESTPlus是否支持OpenAPI响应示例属性?,python,flask,swagger,openapi,flask-restplus,Python,Flask,Swagger,Openapi,Flask Restplus,给定一个RESTPlus模型,如: todo = api.model("Todo", { "id": fields.Integer(example=123), "task": fields.String(example="Feed the cat") }) 我希望Flask RESTPlus支持OpenAPI响应示例属性,以导出如下规范: paths: /todos/{id} get: responses: '200':
todo = api.model("Todo", {
"id": fields.Integer(example=123),
"task": fields.String(example="Feed the cat")
})
我希望Flask RESTPlus支持OpenAPI响应示例属性,以导出如下规范:
paths:
/todos/{id}
get:
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Todo'
examples:
application/json:
id: 123
task: Feed the cat
我已经研究了api.doc()
&api.response()
装饰程序,但它们似乎不支持response属性。例如:
@api.response(200, "OK", todo)
@api.marshal_with(todo)
def get(self):
# . . .
。不填充响应示例属性
版本:flask restplus==0.13.0您确定吗?您使用的是什么版本的Flask RESTPlus?当使用
@api.response(200,“OK”,todo)
时,我得到了示例部分。。。转到项目的根路径,例如127.0.0.1:5000/
。应该有记录响应的路由…使用最新版本(0.13.0),响应示例记录在Swagger UI中,但是当您下载Swagger json(从/Swagger.json端点)时,json在响应部分没有示例属性。它们记录在下面,他们只使用#/definitions/Todo
permalink。在下面,您将看到定义的条目,其中包含Todo模型。