gofiber · uvulpos · Jul 3, 2024 · Jul 3, 2024 · Jul 3, 2024
diff --git a/README.md b/README.md
@@ -12,19 +12,25 @@ fiber middleware to automatically generate RESTful API documentation with Swagge
 
 1. Add comments to your API source code, [See Declarative Comments Format](https://github.com/swaggo/swag#declarative-comments-format).
 2. Download [Swag](https://github.com/swaggo/swag) for Go by using:
+
 ```sh
 go get -u github.com/swaggo/swag/cmd/swag
 # 1.16 or newer
 go install github.com/swaggo/swag/cmd/swag@latest
 ```
+
 3. Run the [Swag](https://github.com/swaggo/swag) in your Go project root folder which contains `main.go` file, [Swag](https://github.com/swaggo/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`).
+
 ```sh
 swag init
 ```
+
 4. Download [swagger](https://github.com/gofiber/swagger) by using:
+
 ```sh
 go get -u github.com/gofiber/swagger
 ```
+
 And import following in your code:
 
 ```go
@@ -77,4 +83,16 @@ func main() {
 	app.Listen(":8080")
 }
 ```
+
 5. Run it, and browser to http://localhost:8080/swagger, you can see Swagger 2.0 Api documents.
+
+### Version Note:
+
+Swagger-UI currently runs on version 5.0.0 and supports OpenAPI sepcifications from
+
+- 3.1.0
+- 3.0.3
+- 3.0.2
+- 3.0.1
+- 3.0.0
+- 2.0
diff --git a/dist/favicon-16x16.png b/dist/favicon-16x16.png
diff --git a/dist/favicon-32x32.png b/dist/favicon-32x32.png
diff --git a/dist/index.css b/dist/index.css
@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}
diff --git a/dist/index.html b/dist/index.html
@@ -0,0 +1,19 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="index.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" />
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="./swagger-initializer.js" charset="UTF-8"> </script>
+  </body>
+</html>
diff --git a/dist/oauth2-redirect.html b/dist/oauth2-redirect.html
@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<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).replace('?', '&');
+        } 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.schema.get("flow") === "authorization_code"
+        ) && !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. The 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();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>
diff --git a/dist/swagger-initializer.js b/dist/swagger-initializer.js
@@ -0,0 +1,20 @@
+window.onload = function() {
+  //<editor-fold desc="Changeable Configuration Block">
+
+  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
+  window.ui = SwaggerUIBundle({
+    url: "https://petstore.swagger.io/v2/swagger.json",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+
+  //</editor-fold>
+};
diff --git a/dist/swagger-ui-bundle.js b/dist/swagger-ui-bundle.js
diff --git a/dist/swagger-ui-bundle.js.map b/dist/swagger-ui-bundle.js.map
diff --git a/dist/swagger-ui-es-bundle-core.js b/dist/swagger-ui-es-bundle-core.js
diff --git a/dist/swagger-ui-es-bundle-core.js.map b/dist/swagger-ui-es-bundle-core.js.map
diff --git a/dist/swagger-ui-es-bundle.js b/dist/swagger-ui-es-bundle.js
diff --git a/dist/swagger-ui-es-bundle.js.map b/dist/swagger-ui-es-bundle.js.map
diff --git a/dist/swagger-ui-standalone-preset.js b/dist/swagger-ui-standalone-preset.js
diff --git a/dist/swagger-ui-standalone-preset.js.map b/dist/swagger-ui-standalone-preset.js.map
diff --git a/dist/swagger-ui.css b/dist/swagger-ui.css
diff --git a/dist/swagger-ui.css.map b/dist/swagger-ui.css.map
diff --git a/dist/swagger-ui.js b/dist/swagger-ui.js
diff --git a/dist/swagger-ui.js.map b/dist/swagger-ui.js.map
diff --git a/files.go b/files.go
@@ -0,0 +1,12 @@
+package swagger
+
+import (
+	"embed"
+	"io/fs"
+)
+
+//go:embed dist/*
+var dist embed.FS
+
+// SwaggerFileSystem holds embedded swagger ui files
+var SwaggerFileSystem, _ = fs.Sub(dist, "dist")
diff --git a/go.mod b/go.mod
@@ -4,7 +4,6 @@ go 1.18
 
 require (
 	github.com/gofiber/fiber/v2 v2.52.5
-	github.com/swaggo/files/v2 v2.0.0
 	github.com/swaggo/swag v1.16.3
 )
 

diff --git a/go.sum b/go.sum
@@ -54,8 +54,6 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
-github.com/swaggo/files/v2 v2.0.0 h1:hmAt8Dkynw7Ssz46F6pn8ok6YmGZqHSVLZ+HQM7i0kw=
-github.com/swaggo/files/v2 v2.0.0/go.mod h1:24kk2Y9NYEJ5lHuCra6iVwkMjIekMCaFq/0JQj66kyM=
 github.com/swaggo/swag v1.16.3 h1:PnCYjPCah8FK4I26l2F/KQ4yz3sILcVUN3cTlBFA9Pg=
 github.com/swaggo/swag v1.16.3/go.mod h1:DImHIuOFXKpMFAQjcC7FG4m3Dg4+QuUgUzJmKjI/gRk=
 github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=

diff --git a/swagger.go b/swagger.go
@@ -11,7 +11,6 @@ import (
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/filesystem"
 	"github.com/gofiber/fiber/v2/utils"
-	swaggerFiles "github.com/swaggo/files/v2"
 	"github.com/swaggo/swag"
 )
 
@@ -34,7 +33,7 @@ func New(config ...Config) fiber.Handler {
 	var (
 		prefix string
 		once   sync.Once
-		fs     = filesystem.New(filesystem.Config{Root: http.FS(swaggerFiles.FS)})
+		fs     = filesystem.New(filesystem.Config{Root: http.FS(SwaggerFileSystem)})
 	)
 
 	return func(c *fiber.Ctx) error {