Отобразить документы об уровне маршрута или операционном уровне на странице сваггера для API flask_restplus - PullRequest
Новая
       34

Отобразить документы об уровне маршрута или операционном уровне на странице сваггера для API flask_restplus

0 голосов
/ 29 октября 2019

Я пытаюсь показать некоторое описание того, что на самом деле делает мой API, на странице документации Swagger для моего flask_restplus API. Проблема в том, что описания уровня параметров отображаются на странице, но описания уровня маршрута или операции (GET / POST / PUT / DELETE) не отображаются.

Я пытался использовать @ ns.docдекоратор класса (уровень маршрута) или метод (уровень операции), я пробовал вызовы, подобные этим: 

@ns.doc('some description', params={common params dict})
@ns.route('/route')
class RouteClass(Resource)
    @ns.doc('operation description', params={operation params dict}, responses={responses documentation})
    def get(self):
        #parse args and call controller

Я также пробовал ключевое слово параметр @ ns.doc (id = 'некоторое описание')...) но безуспешно. Я не вижу никаких описаний на другом уровне, кроме параметров или ответов на странице Swagger API.

Документация api.doc очень краткая на странице flask_restplus и не объясняет, как этого добиться. Возможно ли это в версии плагина 0.13.0?

...