Поддерживает ли Flask RESTPlus свойство примеров ответов Open API? - PullRequest
Новая
       71

Поддерживает ли Flask RESTPlus свойство примеров ответов Open API?

3 голосов
/ 15 октября 2019

Учитывая модель Flask RESTPlus, такую ​​как: 

todo = api.model("Todo", {
    "id": fields.Integer(example=123),
    "task": fields.String(example="Feed the cat")
})

Я хочу, чтобы Flask RESTPlus поддерживал свойство примеров ответов Open API *1004*, чтобы экспортировать спецификации вроде: 

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

...