Issue#26 : New Feature - Option to add custom tag to group Endpoints

flask_swagger_generator/generators/generator.py

@@ -105,6 +105,21 @@ def wrapper(*args, **kwargs):
             return wrapper
         return swagger_security
 
+    def path_tag(self, tag):
+        def swagger_path_tag(func):
+
+            if not self.generated:
+                self.specifier.add_path_tag(
+                    func.__name__, tag
+                )
+
+            @wraps(func)
+            def wrapper(*args, **kwargs):
+                return func(*args, **kwargs)
+
+            return wrapper
+        return swagger_path_tag
+
     def create_schema(self, reference_name, properties):
         return self.specifier.create_schema(reference_name, properties)
 
@@ -116,17 +131,16 @@ def index_endpoints(self, app):
 
         for rule in app.url_map.iter_rules():
 
+            group = None
+            function_name = rule.endpoint
             if len(rule.endpoint.split(".")) > 1:
                 group, function_name = rule.endpoint.split('.')
-                self.specifier.add_endpoint(
+            for path_tag in self.specifier.path_tags:
+                if path_tag.get("function_name") == function_name:
+                    group = path_tag.get("tag")
+            self.specifier.add_endpoint(
                     function_name=function_name,
                     path=str(rule),
                     request_types=rule.methods,
                     group=group
                 )
-            else:
-                self.specifier.add_endpoint(
-                    function_name=rule.endpoint,
-                    path=str(rule),
-                    request_types=rule.methods,
-                )

flask_swagger_generator/specifiers/swagger_specifier.py

@@ -41,6 +41,10 @@ def add_request_body(self, function_name, schema):
     def add_security(self, function_name, security_type: SecurityType):
         raise NotImplementedError()
 
+    @abstractmethod
+    def add_path_tag(self, function_name, tag):
+        raise NotImplementedError()
+
     def set_application_name(self, application_name):
         self.application_name = application_name
 

flask_swagger_generator/specifiers/swagger_three_specifier.py

@@ -462,6 +462,7 @@ def __init__(self):
         self.schemas = []
         self.responses = []
         self.securities = []
+        self.path_tags = []
 
     def perform_write(self, file):
         # Add all request bodies to request_types with same function name
@@ -675,6 +676,10 @@ def add_security(self, function_name, security_type: SecurityType):
         security_model = SwaggerSecurity([function_name], security_type)
         self.securities.append(security_model)
 
+    def add_path_tag(self, function_name: str, tag):
+        path_tag = {"function_name": function_name, "tag": tag}
+        self.path_tags.append(path_tag)
+
     def create_schema(self, reference_name, properties):
         schema = SwaggerSchema(reference_name, properties)
         self.schemas.append(schema)