Added specs-url-scheme option for Api.

Author: dbmoriar

.gitignore

@@ -62,3 +62,9 @@ doc/_build/
 # Specifics
 flask_restx/static
 node_modules
+
+# pyenv
+.python-version
+
+# Jet Brains
+.idea

flask_restx/api.py

@@ -94,6 +94,9 @@ class Api(object):
     :param FormatChecker format_checker: A jsonschema.FormatChecker object that is hooked into
         the Model validator. A default or a custom FormatChecker can be provided (e.g., with custom
         checkers), otherwise the default action is to not enforce any format validation.
+    :param specs_url_scheme: If set to a string (e.g. http, https), then the specs_url will explicitly use this scheme
+        regardless of how the application is deployed. This is necessary for some deployments such as behind an
+        AWS elastic load balancer so that the user recieves the full swagger URL.
     """
 
     def __init__(
@@ -123,6 +126,7 @@ def __init__(
         catch_all_404s=False,
         serve_challenge_on_401=False,
         format_checker=None,
+        specs_url_scheme=None,
         **kwargs
     ):
         self.version = version
@@ -144,10 +148,12 @@ def __init__(
         self._default_error_handler = None
         self.tags = tags or []
 
-        self.error_handlers = OrderedDict({
-            ParseError: mask_parse_error_handler,
-            MaskError: mask_error_handler,
-        })
+        self.error_handlers = OrderedDict(
+            {
+                ParseError: mask_parse_error_handler,
+                MaskError: mask_error_handler,
+            }
+        )
         self._schema = None
         self.models = {}
         self._refresolver = None
@@ -178,6 +184,7 @@ def __init__(
             api=self,
             path="/",
         )
+        self.specs_url_scheme = specs_url_scheme
         if app is not None:
             self.app = app
             self.init_app(app)
@@ -220,7 +227,6 @@ def init_app(self, app, **kwargs):
         else:
             self.blueprint = app
 
-
     def _init_app(self, app):
         """
         Perform initialization actions with the given :class:`flask.Flask` object.
@@ -254,14 +260,13 @@ def _init_app(self, app):
 
         # check for deprecated config variable names
         if "ERROR_404_HELP" in app.config:
-            app.config['RESTX_ERROR_404_HELP'] = app.config['ERROR_404_HELP']
+            app.config["RESTX_ERROR_404_HELP"] = app.config["ERROR_404_HELP"]
             warnings.warn(
                 "'ERROR_404_HELP' config setting is deprecated and will be "
                 "removed in the future. Use 'RESTX_ERROR_404_HELP' instead.",
-                DeprecationWarning
+                DeprecationWarning,
             )
 
-
     def __getattr__(self, name):
         try:
             return getattr(self.default_namespace, name)
@@ -407,7 +412,8 @@ def make_response(self, data, *args, **kwargs):
             kwargs.pop("fallback_mediatype", None) or self.default_mediatype
         )
         mediatype = request.accept_mimetypes.best_match(
-            self.representations, default=default_mediatype,
+            self.representations,
+            default=default_mediatype,
         )
         if mediatype is None:
             raise NotAcceptable()
@@ -515,11 +521,16 @@ def endpoint(self, name):
     @property
     def specs_url(self):
         """
-        The Swagger specifications relative url (ie. `swagger.json`)
+        The Swagger specifications relative url (ie. `swagger.json`). If
+        the spec_url_scheme attribute is set, then the full url is provided instead
+        (e.g. http://localhost/swaggger.json).
 
         :rtype: str
         """
-        return url_for(self.endpoint("specs"))
+        external = None if self.specs_url_scheme is None else True
+        return url_for(
+            self.endpoint("specs"), _scheme=self.specs_url_scheme, _external=external
+        )
 
     @property
     def base_url(self):

flask_restx/inputs.py

@@ -523,9 +523,16 @@ def boolean(value):
     elif not value:
         return False
     value = str(value).lower()
-    if value in ("true", "1", "on",):
+    if value in (
+        "true",
+        "1",
+        "on",
+    ):
         return True
-    if value in ("false", "0",):
+    if value in (
+        "false",
+        "0",
+    ):
         return False
     raise ValueError("Invalid literal for boolean(): {0}".format(value))
 

flask_restx/model.py

@@ -171,7 +171,7 @@ def _schema(self):
         }
 
         if self.__strict__:
-            definition['additionalProperties'] = False
+            definition["additionalProperties"] = False
 
         return not_none(definition)
 

flask_restx/reqparse.py

@@ -106,7 +106,10 @@ def __init__(
         required=False,
         ignore=False,
         type=text_type,
-        location=("json", "values",),
+        location=(
+            "json",
+            "values",
+        ),
         choices=(),
         action="store",
         help=None,

tests/test_api.py

@@ -342,3 +342,13 @@ class TestResource(restx.Resource):
         assert decorator1.called is True
         assert decorator2.called is True
         assert decorator3.called is True
+
+    def test_specs_url(self, app):
+        api = restx.Api(app)
+        specs_url = api.specs_url
+        assert specs_url == "/swagger.json"
+
+    def test_specs_url_api_scheme(self, app):
+        api = restx.Api(app, specs_url_scheme="https")
+        specs_url = api.specs_url
+        assert specs_url == "https://localhost/swagger.json"