Add add_specs to api

This flag allows to select if specs are added into the API or not.

Fixes #464

Author: thejamesmarq

CHANGELOG.rst

@@ -7,6 +7,7 @@ Current
 -------
 
 - Ensure that exceptions raised in error handler, including programming errors, are logged (:issue:`705`, :pr:`706`)
+- Allow to select if specs are added or hidden in the API (:pr:`553`, :issue:`464`)
 
 0.13.0 (2019-08-12)
 -------------------

doc/swagger.rst

@@ -751,6 +751,20 @@ You can hide some resources or methods from documentation using any of the follo
 
    Namespace tags without attached resources will be hidden automatically from the documentation.
 
+It is also possible to hide all the documentation or specs creating the API object like this:
+
+.. code-block:: python
+
+   from flask import Flask
+   from flask_restplus import Api
+
+   # Hide docs (default is '/', meaning that documentation will hang under '/')
+   app = Flask(__name__)
+   api = Api(app, doc=False)
+
+   # Hide specs (default is True, meaning that specs will be generated)
+   api = Api(app, add_specs=False)
+
 
 Documenting authorizations
 --------------------------

flask_restplus/api.py

@@ -87,6 +87,8 @@ 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 bool add_specs: Whether to add specs to the API or disable the specs generation
+        (default 'True')
     '''
 
     def __init__(self, app=None, version='1.0', title=None, description=None,
@@ -97,7 +99,7 @@ def __init__(self, app=None, version='1.0', title=None, description=None,
             tags=None, prefix='', ordered=False,
             default_mediatype='application/json', decorators=None,
             catch_all_404s=False, serve_challenge_on_401=False, format_checker=None,
-            **kwargs):
+            add_specs=True, **kwargs):
         self.version = version
         self.title = title or 'API'
         self.description = description
@@ -149,7 +151,7 @@ def __init__(self, app=None, version='1.0', title=None, description=None,
 
         if app is not None:
             self.app = app
-            self.init_app(app)
+            self.init_app(app, add_specs=add_specs)
         # super(Api, self).__init__(app, **kwargs)
 
     def init_app(self, app, **kwargs):

tests/test_api.py

@@ -95,6 +95,11 @@ def test_specs_endpoint_not_found_if_not_added(self, app, client):
         resp = client.get('/swagger.json')
         assert resp.status_code == 404
 
+    def test_specs_endpoint_not_found_if_not_enabled(self, app, client):
+        restplus.Api(app, add_specs=False)
+        resp = client.get('/swagger.json')
+        assert resp.status_code == 404
+
     def test_default_endpoint(self, app):
         api = restplus.Api(app)