render api docs

rvhonorato · Nov 27, 2024 · 140e978 · 140e978
1 parent e6a1af4
commit 140e978
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 7 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -161,12 +161,12 @@ const docTemplate = `{
 
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
-	Version:          "",
+	Version:          "1.0",
 	Host:             "",
-	BasePath:         "",
+	BasePath:         "/api",
 	Schemes:          []string{},
-	Title:            "",
-	Description:      "",
+	Title:            "jobd (Job Daemon) API",
+	Description:      "API for managing job queue in jobd application",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
 	LeftDelim:        "{{",

diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,29 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>API Documentation</title>
+    <link
+      rel="stylesheet"
+      type="text/css"
+      href="https://unpkg.com/[email protected]/swagger-ui.css"
+    />
+    <script src="https://unpkg.com/[email protected]/swagger-ui-bundle.js"></script>
+  </head>
+  <body>
+    <div id="swagger-ui"></div>
+    <script>
+      window.onload = function () {
+        SwaggerUIBundle({
+          url: "./swagger.json",
+          dom_id: "#swagger-ui",
+          presets: [
+            SwaggerUIBundle.presets.apis,
+            SwaggerUIBundle.SwaggerUIStandalonePreset,
+          ],
+          layout: "BaseLayout",
+        });
+      };
+    </script>
+  </body>
+</html>
diff --git a/docs/swagger.json b/docs/swagger.json
@@ -1,8 +1,12 @@
 {
     "swagger": "2.0",
     "info": {
-        "contact": {}
+        "description": "API for managing job queue in jobd application",
+        "title": "jobd (Job Daemon) API",
+        "contact": {},
+        "version": "1.0"
     },
+    "basePath": "/api",
     "paths": {
         "/api/get/{id}": {
             "get": {

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -1,3 +1,4 @@
+basePath: /api
 definitions:
   errors.RestErr:
     properties:
@@ -31,6 +32,9 @@ definitions:
     type: object
 info:
   contact: {}
+  description: API for managing job queue in jobd application
+  title: jobd (Job Daemon) API
+  version: "1.0"
 paths:
   /api/get/{id}:
     get:

diff --git a/main.go b/main.go
@@ -19,8 +19,11 @@ func init() {
 	flag.Parse()
 }
 
+// @title jobd (Job Daemon) API
+// @version 1.0
+// @description API for managing job queue in jobd application
+// @BasePath /api
 func main() {
-
 	errDB := db.InitDB()
 	if errDB != nil {
 		log.Fatal(errDB)
@@ -35,5 +38,4 @@ func main() {
 
 	r := router.SetupRouter()
 	_ = r.Run()
-
 }