jupyter-servergh-1418: swagger-ui strawman

.gitignore

@@ -9,6 +9,7 @@ docs/gh-pages
 jupyter_server/i18n/*/LC_MESSAGES/*.mo
 jupyter_server/i18n/*/LC_MESSAGES/nbjs.json
 jupyter_server/static/style/*.min.css*
+jupyter_server/static/vendor/
 node_modules
 *.py[co]
 __pycache__

jupyter_server/services/api/handlers.py

@@ -43,6 +43,18 @@ def get_content_type(self):
         return "text/x-yaml"
 
 
+class APIDocsHandler(JupyterHandler):
+    """A handler for the documentation of the REST API."""
+
+    auth_resource = AUTH_RESOURCE
+
+    @web.authenticated
+    @authorized
+    async def get(self):
+        """Get the REST API documentation."""
+        return self.finish(self.render_template("apidocs.html"))
+
+
 class APIStatusHandler(APIHandler):
     """An API status handler."""
 
@@ -115,6 +127,7 @@ async def get(self):
 
 
 default_handlers = [
+    (r"/api/apidocs", APIDocsHandler),
     (r"/api/spec.yaml", APISpecHandler),
     (r"/api/status", APIStatusHandler),
     (r"/api/me", IdentityHandler),

jupyter_server/templates/apidocs.html

@@ -0,0 +1,27 @@
+{% extends "page.html" %}
+
+{% block stylesheet %}
+    {{ super() }}
+    <link rel="stylesheet" href="{{ static_url('vendor/swagger-ui/swagger-ui.css') }}" />
+    <style>
+        .swagger-ui .info .title small pre {
+            background-color: transparent;
+            border: 0;
+        }
+    </style>
+{% endblock stylesheet %}
+
+{% block site %}
+    <div id="swagger-ui"></div>
+{% endblock site %}
+
+{% block script %}
+    {{ super() }}
+    <script src="{{ static_url('vendor/swagger-ui/swagger-ui-bundle.js') }}"></script>
+
+    <script>
+        ;(function(){
+            SwaggerUIBundle({ url: "./spec.yaml", dom_id: "#swagger-ui" });
+        }).call(this);
+    </script>
+{% endblock script %}