Implemented the SwaggerUI urls config parameter which displays a dropdown of API specs instead of an editable textbox (flasgger#473)

Author: jvpernis

examples/multiple_specs_dropdown_example.py

@@ -0,0 +1,81 @@
+"""
+In this example a spec name is provided in order to trigger SwaggeUI's dropdown list of specs.
+"""
+from flask import Flask, jsonify
+try:
+    from http import HTTPStatus
+except ImportError:
+    import httplib as HTTPStatus
+from flasgger import Swagger
+from flasgger.utils import swag_from
+
+
+swagger_config = {
+    "headers": [
+    ],
+    "specs": [
+        {
+            "version": "0.0.1",
+            "title": "Api v1",
+            "name": "v1",
+            "endpoint": 'v1_spec',
+            "description": 'This is the version 1 of our API',
+            "route": '/v1/spec',
+            "rule_filter": lambda rule: rule.rule.startswith('/v1/'),
+        },
+        {
+            "version": "0.0.2",
+            "title": "Api v2",
+            "name": "v2",
+            "description": 'This is the version 2 of our API',
+            "endpoint": 'v2_spec',
+            "route": '/v2/spec',
+            "rule_filter": lambda rule: rule.rule.startswith('/v2/'),
+        }
+    ],
+    "static_url_path": "/flasgger_static",
+}
+
+app = Flask(__name__)
+swag = Swagger(app, config=swagger_config)
+
+
+
+@app.route('/v1/hello')
+def v1_hello():
+    """
+    A test view
+
+    ---
+    responses:
+      200:
+        description: OK
+    """
+    return jsonify(hello="world")
+
+
+@app.route('/v2/hello')
+def v2_hello():
+    """
+    A test view v2
+
+    ---
+    responses:
+      200:
+        description: OK
+    """
+    return jsonify(hello="world")
+
+
+def test_swag(client, specs_data):
+    """
+    This test is runs automatically in Travis CI
+
+    :param client: Flask app test client
+    :param specs_data: {'url': {swag_specs}} for every spec in app
+    """
+    assert client.get('/apidocs/').status_code == HTTPStatus.OK
+
+
+if __name__ == '__main__':
+    app.run(debug=True)

flasgger/base.py

@@ -78,13 +78,22 @@ def get(self):
             {
                 "url": url_for(".".join((base_endpoint, spec['endpoint']))),
                 "title": spec.get('title', 'API Spec 1'),
+                "name": spec.get('name', None),
                 "version": spec.get("version", '0.0.1'),
                 "endpoint": spec.get('endpoint')
             }
             for spec in self.config.get('specs', [])
         ]
+        urls = [
+            {
+                "name": spec["name"],
+                "url": spec["url"]
+            }
+            for spec in specs if spec["name"]
+        ]
         data = {
             "specs": specs,
+            "urls": urls,
             "title": self.config.get('title', 'Flasgger')
         }
         if request.args.get('json'):

flasgger/ui3/templates/flasgger/swagger.html

@@ -11,7 +11,11 @@
     Object.assign(
     {
 
+    {% if urls %}
+    urls: {{ urls | tojson }},
+    {% else %}
     url: "{{ specs[0]['url'] }}",
+    {% endif %}
     dom_id: '#swagger-ui',
     validatorUrl: null,
     displayOperationId: true,