Документация по API (пользовательский интерфейс Swagger) для функции Python Azure

Мы создали API-интерфейсы на основе функции Azure, и все API-интерфейсы основаны на Python. Я знаю, что APIM предоставляет удобный способ импорта функций Azure, а также создания API-интерфейсов и управления ими. Однако я ищу легкое и быстрое решение для разработчиков, чтобы они могли работать друг с другом.

Swagger очень популярен в экосистеме Java, и мы используем его в нашем приложении весенней загрузки, просто добавляя несколько аннотаций.

Есть ли что-нибудь подобное для функций Azure, написанных на Python. Моя конечная цель - предоставить документацию по API, доступную для некоторых конечных точек, чтобы разные команды (производители и потребители API) могли работать эффективно, не сталкиваясь с слиянием и т. Д.


person SunilS    schedule 27.01.2021    source источник


Ответы (2)


Я не уверен, сможете ли вы это сделать, но у компании, в которой я работаю, есть SwaggerHub, который позволяет мне создавать заглушки сервера на нескольких языках, включая python-flask. Я попробовал это на одном из наших API и проверил код - он использует фреймворк Connexion - см. здесь и здесь.

Connexion - это фреймворк поверх Flask, который автоматически обрабатывает HTTP-запросы, определенные с помощью OpenAPI.

Еще одно замечание; похоже, что вы можете использовать фреймворк для приложения функции Azure согласно здесь .

person Ryan.Bartsch    schedule 04.06.2021

С Azure это довольно просто. Поскольку это функции, использование чванства не имеет смысла, и я думаю, это тоже будет невозможно.

В Azure есть встроенная служба определения открытого API. Все, что вам нужно сделать, это создать API Management Instance, и они импортируют в него functions. После импорта всех функций вы можете загрузить файл OpenAPI definition. Вы даже можете разместить его где-нибудь для облегчения доступа.

Вот ссылка на подробное руководство.

person Debdut Goswami    schedule 07.06.2021