Можем ли мы автоматически добавить зефирный шем в чванство `api.do c ()`? - PullRequest
Новая
       26

Можем ли мы автоматически добавить зефирный шем в чванство `api.do c ()`?

0 голосов
/ 12 апреля 2020

У меня есть API, который я хотел бы отобразить через интерфейс Swagger. Я делаю это: 

bp = Blueprint("api", __name__)
api = Api(bp)

@api.doc(
    description="Description, I want to add schema here",
    responses={200: "Success"},
)
def post(self):
    """ Appears in Title of Swagger
        Authorization: Bearer <auth-key>
    """
    return jsonify(200)

Допустим, у меня есть следующая схема: 

class SomeSchema(Schema):
    id = fields.String(required=True)

Есть ли способ автоматически отобразить эту схему для чванства? Например, я хотел бы заполнить:

enter image description here

для автоматического заполнения полей.

1 Ответ

0 голосов
/ 13 апреля 2020

Это именно то, для чего предназначен apispe c. Он разработан командой разработчиков зефира.

(Вас также могут заинтересовать веб-аргументы для анализа входных данных с помощью зефира. И flask -самый высокий для интеграции apispe c и webargs в полной структуре API.)

Отказ от ответственности: зефир / apispec / webargs / flask -самый сопровождающий.

...