Use prance library to get bundled specs (#115)

* use prance library to get bundled OAS

* prevent import errors

Co-authored-by: Fernando Arruza <[email protected]>

Author: f-arruza

Pipfile.lock

@@ -1,8 +1,15 @@
 import os
+from pathlib import Path
+from typing import Dict, Any
 
 import connexion
 from connexion.resolver import RestyResolver
 
+try:
+    import prance
+except ModuleNotFoundError:  # pragma: no cover
+    prance = None
+
 from pyms.exceptions import AttrDoesNotExistException
 from pyms.flask.services.driver import DriverService
 from pyms.utils import check_package_exists
@@ -40,6 +47,13 @@ def _get_application_root(config):
             application_root = "/"
         return application_root
 
+    @staticmethod
+    def get_bundled_specs(main_file: Path) -> Dict[str, Any]:
+        parser = prance.ResolvingParser(str(main_file.absolute()),
+                                        lazy=True, backend='openapi-spec-validator')
+        parser.parse()
+        return parser.specification
+
     def init_app(self, config, path):
         """
         Initialize Connexion App. See more info in [Connexion Github](https://github.com/zalando/connexion)
@@ -75,7 +89,8 @@ def init_app(self, config, path):
                             resolver=RestyResolver(self.project_dir))
 
         params = {
-            "specification": self.file,
+            "specification": self.get_bundled_specs(
+                Path(os.path.join(specification_dir, self.file))) if prance else self.file,
             "arguments": {'title': config.APP_NAME},
             "base_path": application_root,
             "options": {"swagger_url": self.url},

pyms/flask/services/swagger.py

@@ -39,6 +39,8 @@
     'connexion[swagger-ui]>=2.6.0',
     'swagger-ui-bundle>=0.0.6',
     'anyconfig>=0.9.8',
+    'semver>=2.9.1',
+    'prance>=0.18.2',
 ]
 
 install_traces_requires = [

setup.py

@@ -38,9 +38,9 @@ paths:
       produces:
       - "application/json"
       responses:
-        200:
+        "200":
           description: "Example"
-        405:
+        "405":
           description: "Invalid input"
       x-swagger-router-controller: "tests.test_flask"
 externalDocs:

tests/swagger.yaml

@@ -38,9 +38,9 @@ paths:
       produces:
       - "application/json"
       responses:
-        200:
+        "200":
           description: "Example"
-        405:
+        "405":
           description: "Invalid input"
       x-swagger-router-controller: "tests.test_flask"
 externalDocs: