Merge pull request #38 from inkhey/fix/pyramid-swagger-ui

hapic/ext/pyramid/context.py

@@ -147,3 +147,31 @@ class PyramidContext(BaseContext):
 
     def by_pass_output_wrapping(self, response: typing.Any) -> bool:
         return False
+
+    def add_view(
+        self,
+        route: str,
+        http_method: str,
+        view_func: typing.Callable[..., typing.Any],
+    ) -> None:
+
+        self.configurator.add_route(
+            name=route,
+            path=route,
+            request_method=http_method
+        )
+
+        self.configurator.add_view(
+            view_func,
+            route_name=route,
+        )
+
+    def serve_directory(
+        self,
+        route_prefix: str,
+        directory_path: str,
+    ) -> None:
+        self.configurator.add_static_view(
+            name=route_prefix,
+            path=directory_path,
+        )

hapic/hapic.py

@@ -409,16 +409,11 @@ class Hapic(object):
         if not route.endswith('/'):
             route = '{}/'.format(route)
 
-        # Add swagger directory as served static dir
         swaggerui_path = os.path.join(
             os.path.dirname(os.path.abspath(__file__)),
             'static',
             'swaggerui',
         )
-        self.context.serve_directory(
-            route,
-            swaggerui_path,
-        )
 
         # Documentation file view
         doc_yaml = self.doc_generator.get_doc_yaml(
@@ -428,7 +423,15 @@ class Hapic(object):
             description=description,
         )
 
-        def spec_yaml_view():
+        def spec_yaml_view(*args, **kwargs):
+            """
+            Method to return swagger generated yaml spec file.
+
+            This method will be call as a framework view, like those,
+            it need to handle the default arguments of a framework view.
+            As frameworks have different arguments patterns, we should
+            allow any arguments patterns (args, kwargs).
+            """
             return self.context.get_response(
                 doc_yaml,
                 mimetype='text/x-yaml',
@@ -445,14 +448,22 @@ class Hapic(object):
         )
 
         # Declare the swaggerui view
-        def api_doc_view():
+        def api_doc_view(*args, **kwargs):
+            """
+            Method to return html index view of swagger ui.
+
+            This method will be call as a framework view, like those,
+            it need to handle the default arguments of a framework view.
+            As frameworks have different arguments patterns, we should
+            allow any arguments patterns (args, kwargs).
+            """
             return self.context.get_response(
                 doc_page_content,
                 http_code=HTTPStatus.OK,
                 mimetype='text/html',
             )
 
-        # Add a view to generate the html index page of swaggerui
+        # Add a view to generate the html index page of swagger-ui
         self.context.add_view(
             route=route,
             http_method='GET',
@@ -465,3 +476,9 @@ class Hapic(object):
             http_method='GET',
             view_func=spec_yaml_view,
         )
+
+        # Add swagger directory as served static dir
+        self.context.serve_directory(
+            route,
+            swaggerui_path,
+        )