命名空间分组

时间:2018-09-26 15:58:44

标签: flask-restplus

我想知道命名空间本身是否可以分组?

我们的REST服务器项目具有高度分散的结构(沿着Redux分形模式),并且每个功能都有其自己的名称空间。可以预见的是,这导致了许多名称空间,并且庞大的页面现在变得越来越满。

如果这无法实现,我想我们可以接受,或者考虑只发出由官方Swagger UI使用的swagger json,而我们可以在单独的服务器中运行它。但是我更喜欢restplus-y解决方案,因为它代表了最少的代码冲突。

1 个答案:

答案 0 :(得分:0)

基础OpenAPI Specification具有标签的概念。 Flask-RESTPlus中的名称空间功能将这些名称分配为路径定义的标签,因此这就是在Swagger UI中进行分组的方式。该规范不提供任何分层分组机制,因此Flask-RESTPlus不提供任何此类功能。

您可以考虑采用不同的策略来分配名称空间/标签以创建更易于管理的分组,将API拆分到多个Swagger UI页面/站点等。听起来,您的Swagger UI周围没有办法需要渲染大量数字API方法,因此最好通过一般的内容结构使其更易于理解。