feat: add swagger docs replacing swaggo (#68)

igh9410 · Oct 13, 2024 · 00aaddc · 00aaddc
1 parent b604d17
commit 00aaddc
Show file tree

Hide file tree

Showing 40 changed files with 993 additions and 633 deletions.
diff --git a/backend/.gitignore b/backend/.gitignore
@@ -30,8 +30,7 @@ curl.txt
 jwt.txt
 docker_commands.txt
 access_token.txt
-index.html
-index2.html
+
 
 # Virtual Environment
 myenv/

diff --git a/backend/Makefile b/backend/Makefile
@@ -55,7 +55,7 @@ test:
 # Generate Swagger documentation from proto files
 generate-docs:
 	@echo "Generating OpenAPI documentation..."
-	@protoc --proto_path=${PROTO_PATH} -I=proto/third_party --openapi_out=api --openapi_opt=enum_type=string ${PROTO_PATH}/*.proto
+	@protoc --proto_path=${PROTO_PATH} -I=proto/third_party --openapi_out=internal/api --openapi_opt=enum_type=string ${PROTO_PATH}/*.proto
 
 # Generate server code from OpenAPI specification
 generate-server:

diff --git a/backend/cmd/blabber-hive/main.go b/backend/cmd/blabber-hive/main.go
@@ -10,13 +10,13 @@ import (
 	"strconv"
 	"syscall"
 
+	server "github.com/igh9410/blabber-hive/backend/internal/app/application/server"
 	db "github.com/igh9410/blabber-hive/backend/internal/app/infrastructure/database"
 	"github.com/igh9410/blabber-hive/backend/internal/app/infrastructure/kafka"
 	"github.com/igh9410/blabber-hive/backend/internal/app/infrastructure/redis"
 	"github.com/igh9410/blabber-hive/backend/internal/chat"
 	"github.com/igh9410/blabber-hive/backend/internal/match"
 	"github.com/igh9410/blabber-hive/backend/internal/user"
-	"github.com/igh9410/blabber-hive/backend/router"
 
 	"time"
 
@@ -123,15 +123,15 @@ func main() {
 		log.Fatalf("Failed to initialize Kafka consumer: %s", err)
 	}
 
-	routerConfig := &router.RouterConfig{
+	routerConfig := &server.RouterConfig{
 		UserHandler:   userHandler,
 		ChatHandler:   chatHandler,
 		ChatWsHandler: chatWsHandler,
 		MatchHandler:  matchHandler,
 		// Future handlers can be added here without changing the InitRouter signature
 	}
 
-	r := router.InitRouter(routerConfig)
+	r := server.InitRouter(routerConfig)
 
 	srv := &http.Server{
 		Addr:    ":8080",

diff --git a/backend/docs/swagger-ui/favicon-16x16.png b/backend/docs/swagger-ui/favicon-16x16.png
diff --git a/backend/docs/swagger-ui/favicon-32x32.png b/backend/docs/swagger-ui/favicon-32x32.png
diff --git a/backend/docs/swagger-ui/index.css b/backend/docs/swagger-ui/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/backend/docs/swagger-ui/index.html b/backend/docs/swagger-ui/index.html
@@ -0,0 +1,40 @@
+<!-- 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>
+      window.onload = function () {
+        // Make sure the URL points to the correct path for swagger.json or openapi.yaml
+        const ui = SwaggerUIBundle({
+          url: "/swagger.json", // Check if this matches your correct swagger.json endpoint
+          dom_id: "#swagger-ui",
+          presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
+          layout: "StandaloneLayout",
+        });
+      };
+    </script>
+    <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/backend/docs/swagger-ui/oauth2-redirect.html b/backend/docs/swagger-ui/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/backend/docs/swagger-ui/swagger-initializer.js b/backend/docs/swagger-ui/swagger-initializer.js
@@ -0,0 +1,17 @@
+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: "/swagger.json",
+    dom_id: "#swagger-ui",
+    deepLinking: true,
+    presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
+    plugins: [SwaggerUIBundle.plugins.DownloadUrl],
+    layout: "StandaloneLayout",
+    withCredentials: true,
+    credentials: "include",
+  });
+
+  //</editor-fold>
+};
diff --git a/backend/docs/swagger-ui/swagger-ui-bundle.js b/backend/docs/swagger-ui/swagger-ui-bundle.js
diff --git a/backend/docs/swagger-ui/swagger-ui-bundle.js.map b/backend/docs/swagger-ui/swagger-ui-bundle.js.map
diff --git a/backend/docs/swagger-ui/swagger-ui-es-bundle-core.js b/backend/docs/swagger-ui/swagger-ui-es-bundle-core.js
diff --git a/backend/docs/swagger-ui/swagger-ui-es-bundle-core.js.map b/backend/docs/swagger-ui/swagger-ui-es-bundle-core.js.map
diff --git a/backend/docs/swagger-ui/swagger-ui-es-bundle.js b/backend/docs/swagger-ui/swagger-ui-es-bundle.js
diff --git a/backend/docs/swagger-ui/swagger-ui-es-bundle.js.map b/backend/docs/swagger-ui/swagger-ui-es-bundle.js.map
diff --git a/backend/docs/swagger-ui/swagger-ui-standalone-preset.js b/backend/docs/swagger-ui/swagger-ui-standalone-preset.js
diff --git a/backend/docs/swagger-ui/swagger-ui-standalone-preset.js.map b/backend/docs/swagger-ui/swagger-ui-standalone-preset.js.map
diff --git a/backend/docs/swagger-ui/swagger-ui.css b/backend/docs/swagger-ui/swagger-ui.css
diff --git a/backend/docs/swagger-ui/swagger-ui.css.map b/backend/docs/swagger-ui/swagger-ui.css.map
diff --git a/backend/docs/swagger-ui/swagger-ui.js b/backend/docs/swagger-ui/swagger-ui.js
diff --git a/backend/docs/swagger-ui/swagger-ui.js.map b/backend/docs/swagger-ui/swagger-ui.js.map
diff --git a/backend/infra/kafka/batch.go b/backend/infra/kafka/batch.go