Группировка пространств имен

Question

Мне было интересно, можно ли сгруппировать сами пространства имен?

Наш проект сервера REST имеет высоко децентрализованную структуру (по образцу фрактального шаблона Redux), и каждая функция имеет свое пространство имен.Это, как и ожидалось, привело к появлению множества пространств имён, и страница развязности теперь становится довольно полной.

Если это недостижимо, я думаю, что мы можем с этим смириться или рассмотреть возможность создания только swagger json, который будет использоваться официальным интерфейсом Swagger, который мы можем запустить на отдельном сервере.Но я бы предпочел решение restplus-y, так как оно представляет наименьшее количество трений в коде.

Answer 1

Базовая Спецификация OpenAPI имеет понятие тегов.Функция пространства имен в Flask-RESTPlus назначает эти имена в качестве тегов для определений пути, поэтому вы получаете группировку в пользовательском интерфейсе Swagger.Спецификация не предлагает какого-либо механизма иерархической группировки, поэтому Flask-RESTPlus не предлагает никакой такой функции.

Можно рассмотреть другую стратегию для назначения пространств имен / тегов для создания более управляемых группировок, разбить API на частинесколько страниц / сайтов пользовательского интерфейса Swagger и т. д. Похоже, что нет никакого способа обойтись без пользовательского интерфейса Swagger, требующего визуализации очень большого числа методов API, поэтому лучшим подходом может стать его более понятное с помощью общего структурирования контента.