elixir-maru · efcasado · Mar 11, 2018
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ defmodule API do
 
   plug Plug.Logger
 
-  swagger at:         "/swagger",      # (required) the mount point for the URL
+  swagger at:         "/api-docs",     # (required) the mount point for the URL
           pretty:     true,            # (optional) should JSON be pretty-printed?
           only:       [:dev],          # (optional) the environments swagger works
           except:     [:prod],         # (optional) the environments swagger NOT works
@@ -46,7 +46,8 @@ defmodule API do
 end
 ```
 
-and then you can get json response from `curl http://127.0.0.1:4000/swagger`.
+and then you can get json response from `curl http://127.0.0.1:4000/api-docs/swagger.json`. The
+Swagger UI can be loaded in `http://127.0.0.1:4000/api-docs/`.
 
 open [Swagger Petstore](http://petstore.swagger.io) in your borwser and fill in `http://127.0.0.1:4000/swagger` and enjoy maru_swagger.
 
@@ -55,3 +56,4 @@ open [Swagger Petstore](http://petstore.swagger.io) in your borwser and fill in
 
 * [Cifer](https://github.com/Cifer-Y)
 * [Roman Heinrich](https://github.com/mindreframer)
+* [Enrique Fernandez](https://github.com/efcasado)
diff --git a/lib/maru_swagger/config_struct.ex b/lib/maru_swagger/config_struct.ex
@@ -1,7 +1,9 @@
 defmodule MaruSwagger.ConfigStruct do
   defstruct [
+    # [string]  where to mount the Swagger UI
+    :ui_path,    
     # [string]  where to mount the Swagger JSON
-    :path,
+    :sw_path,
     # [atom]    Maru API module
     :module,
     # [boolean] force JSON for all params instead of formData
@@ -15,7 +17,8 @@ defmodule MaruSwagger.ConfigStruct do
   ]
 
   def from_opts(opts) do
-    path = opts |> Keyword.fetch!(:at) |> Maru.Utils.split_path()
+    ui_path = opts |> Keyword.fetch!(:at) |> Maru.Utils.split_path()
+    sw_path = ui_path ++ ["swagger.json"]
     module = opts |> Keyword.fetch!(:module)
     force_json = opts |> Keyword.get(:force_json, false)
     pretty = opts |> Keyword.get(:pretty, false)
@@ -29,7 +32,8 @@ defmodule MaruSwagger.ConfigStruct do
     info = opts |> Keyword.get(:info, []) |> check_info_inject_keys
 
     %__MODULE__{
-      path: path,
+      ui_path: ui_path,
+      sw_path: sw_path,
       module: module,
       force_json: force_json,
       pretty: pretty,

diff --git a/lib/maru_swagger/dsl.ex b/lib/maru_swagger/dsl.ex
@@ -1,5 +1,6 @@
 defmodule MaruSwagger.DSL do
   defmacro swagger(options) do
+    at = options |> Keyword.get(:at)
     only = options |> Keyword.get(:only)
     except = options |> Keyword.get(:except)
 
@@ -13,13 +14,21 @@ defmodule MaruSwagger.DSL do
 
     quote do
       if unquote(guard) do
-        @plugs_before {
-          MaruSwagger.Plug,
-          unquote(options)
-          |> Keyword.drop([:only, :except])
-          |> Keyword.put(:module, __MODULE__),
-          true
-        }
+        @plugs_before [
+          {
+            MaruSwagger.Plug,
+            unquote(options)
+            |> Keyword.drop([:only, :except])
+            |> Keyword.put(:module, __MODULE__),
+            true
+          },
+          {
+            Plug.Static,
+            [at: unquote(at),
+            from: :maru_swagger],
+            true
+          }
+        ]
       end
     end
   end

diff --git a/lib/maru_swagger/plug.ex b/lib/maru_swagger/plug.ex
@@ -7,7 +7,16 @@ defmodule MaruSwagger.Plug do
     ConfigStruct.from_opts(opts)
   end
 
-  def call(%Conn{path_info: path} = conn, %ConfigStruct{path: path} = config) do
+  def call(%Conn{path_info: path} = conn, %ConfigStruct{ui_path: path} = _config) do
+    priv_dir = :code.priv_dir(:maru_swagger) |> to_string
+    file = Path.join(priv_dir, "static/index.html")
+    conn
+    |> Conn.put_resp_header("access-control-allow-origin", "*")
+    |> Conn.put_resp_content_type("text/html")
+    |> send_file(200, file)
+    |> Conn.halt()
+  end
+  def call(%Conn{path_info: path} = conn, %ConfigStruct{sw_path: path} = config) do
     resp = generate(config) |> Poison.encode!(pretty: config.pretty)
 
     conn

diff --git a/mix.exs b/mix.exs
@@ -24,7 +24,10 @@ defmodule MaruSwagger.Mixfile do
   end
 
   defp deps do
-    [{:maru, github: "elixir-maru/maru"}, {:ex_doc, "~> 0.14", only: :docs}]
+    [
+      {:maru, github: "efcasado/maru", branch: "swagger-ui"},
+      {:ex_doc, "~> 0.14", only: :docs}
+    ]
   end
 
   defp package do

diff --git a/priv/static/favicon-16x16.png b/priv/static/favicon-16x16.png
diff --git a/priv/static/favicon-32x32.png b/priv/static/favicon-32x32.png
diff --git a/priv/static/index.html b/priv/static/index.html
@@ -0,0 +1,95 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
+  <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
+  <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+  <style>
+    html
+    {
+      box-sizing: border-box;
+      overflow: -moz-scrollbars-vertical;
+      overflow-y: scroll;
+    }
+    *,
+    *:before,
+    *:after
+    {
+      box-sizing: inherit;
+    }
+
+    body {
+      margin:0;
+      background: #fafafa;
+    }
+  </style>
+</head>
+
+<body>
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
+  <defs>
+    <symbol viewBox="0 0 20 20" id="unlocked">
+          <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="locked">
+      <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="close">
+      <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow">
+      <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow-down">
+      <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
+    </symbol>
+
+
+    <symbol viewBox="0 0 24 24" id="jump-to">
+      <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 24 24" id="expand">
+      <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
+    </symbol>
+
+  </defs>
+</svg>
+
+<div id="swagger-ui"></div>
+
+<script src="./swagger-ui-bundle.js"> </script>
+<script src="./swagger-ui-standalone-preset.js"> </script>
+<script>
+window.onload = function() {
+
+  // Build a system
+  const ui = SwaggerUIBundle({
+    url: window.location.href + "/swagger.json",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  })
+
+  window.ui = ui
+}
+</script>
+</body>
+
+</html>
diff --git a/priv/static/index.html~ b/priv/static/index.html~
@@ -0,0 +1,95 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Swagger UI</title>
+  <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
+  <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
+  <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+  <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+  <style>
+    html
+    {
+      box-sizing: border-box;
+      overflow: -moz-scrollbars-vertical;
+      overflow-y: scroll;
+    }
+    *,
+    *:before,
+    *:after
+    {
+      box-sizing: inherit;
+    }
+
+    body {
+      margin:0;
+      background: #fafafa;
+    }
+  </style>
+</head>
+
+<body>
+
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
+  <defs>
+    <symbol viewBox="0 0 20 20" id="unlocked">
+          <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="locked">
+      <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="close">
+      <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow">
+      <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 20 20" id="large-arrow-down">
+      <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
+    </symbol>
+
+
+    <symbol viewBox="0 0 24 24" id="jump-to">
+      <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
+    </symbol>
+
+    <symbol viewBox="0 0 24 24" id="expand">
+      <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
+    </symbol>
+
+  </defs>
+</svg>
+
+<div id="swagger-ui"></div>
+
+<script src="./swagger-ui-bundle.js"> </script>
+<script src="./swagger-ui-standalone-preset.js"> </script>
+<script>
+window.onload = function() {
+
+  // Build a system
+  const ui = SwaggerUIBundle({
+    url: "http://petstore.swagger.io/v2/swagger.json",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  })
+
+  window.ui = ui
+}
+</script>
+</body>
+
+</html>
diff --git a/priv/static/oauth2-redirect.html b/priv/static/oauth2-redirect.html
@@ -0,0 +1,67 @@
+<!doctype html>
+<html lang="en-US">
+<body onload="run()">
+</body>
+</html>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1);
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&")
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';})
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value)
+                }
+        ) : {}
+
+        isValid = qp.state === sentState
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode"||
+          oauth2.auth.schema.get("flow") === "authorizationCode"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+</script>
diff --git a/priv/static/swagger-ui-bundle.js b/priv/static/swagger-ui-bundle.js
diff --git a/priv/static/swagger-ui-bundle.js.map b/priv/static/swagger-ui-bundle.js.map
diff --git a/priv/static/swagger-ui-standalone-preset.js b/priv/static/swagger-ui-standalone-preset.js
diff --git a/priv/static/swagger-ui-standalone-preset.js.map b/priv/static/swagger-ui-standalone-preset.js.map
diff --git a/priv/static/swagger-ui.css b/priv/static/swagger-ui.css
diff --git a/priv/static/swagger-ui.css.map b/priv/static/swagger-ui.css.map
diff --git a/priv/static/swagger-ui.js b/priv/static/swagger-ui.js
diff --git a/priv/static/swagger-ui.js.map b/priv/static/swagger-ui.js.map