feat: added swagger feature to compage for go-gin-server framework

Author: azar-writes-code

internal/languages/golang/common.go

@@ -0,0 +1,11 @@
+package golang
+
+import "os/exec"
+
+// commandExists checks if a command exists in the system.
+// cmd: the command to check.
+// bool: true if the command exists, false otherwise.
+func commandExists(cmd string) bool {
+	_, err := exec.LookPath(cmd)
+	return err == nil
+}

internal/languages/golang/frameworks/go-gin-server/copier.go

@@ -42,6 +42,9 @@ const SQLServiceFile = "sqls-service.go.tmpl"
 const MySQLDaoFile = "mysql-dao.go.tmpl"
 const SQLModelFile = "sqls-model.go.tmpl"
 
+// utils file for common functions in controllers 
+const UtilsControllerFile = "common.go.tmpl"
+
 const DaoFile = "dao.go.tmpl"
 const SQLiteDaoFile = "sqlite-dao.go.tmpl"
 const MySQLDBConfigFile = "mysql.go.tmpl"
@@ -472,6 +475,15 @@ func (c *Copier) copyNoSQLDBResourceFiles(resourceName string, filePaths []*stri
 	}
 	filePaths = append(filePaths, &targetResourceControllerFileName)
 
+	// copy controller common file to a generated project
+	targetResourceControllerUtilsFileName := c.NodeDirectoryName + ControllersPath + "/" + UtilsControllerFile
+	_, err = utils.CopyFile(targetResourceControllerUtilsFileName, c.TemplatesRootPath+ControllersPath+"/"+UtilsControllerFile)
+	if err != nil {
+		log.Debugf("error copying controller utils file: %v", err)
+		return nil, err
+	}
+	filePaths = append(filePaths, &targetResourceControllerUtilsFileName)
+
 	// copy model files to a generated project
 	targetResourceModelFileName := c.NodeDirectoryName + ModelsPath + "/" + resourceName + "-" + strings.Replace(NoSQLModelFile, "nosqls-", "", 1)
 	_, err = utils.CopyFile(targetResourceModelFileName, c.TemplatesRootPath+ModelsPath+"/"+NoSQLModelFile)
@@ -515,6 +527,15 @@ func (c *Copier) copySQLDBResourceFiles(resourceName string, filePaths []*string
 	}
 	filePaths = append(filePaths, &targetResourceControllerFileName)
 
+	// copy controller common file to a generated project
+	targetResourceControllerUtilsFileName := c.NodeDirectoryName + ControllersPath + "/" + UtilsControllerFile
+	_, err = utils.CopyFile(targetResourceControllerUtilsFileName, c.TemplatesRootPath+ControllersPath+"/"+UtilsControllerFile)
+	if err != nil {
+		log.Debugf("error copying controller utils file: %v", err)
+		return nil, err
+	}
+	filePaths = append(filePaths, &targetResourceControllerUtilsFileName)
+	
 	// copy service files to a generated project
 	targetResourceServiceFileName := c.NodeDirectoryName + ServicesPath + "/" + resourceName + "-" + strings.Replace(SQLServiceFile, "sqls-", "", 1)
 	_, err = utils.CopyFile(targetResourceServiceFileName, c.TemplatesRootPath+ServicesPath+"/"+SQLServiceFile)

internal/languages/golang/generator.go

@@ -60,6 +60,13 @@ func Generate(ctx context.Context) error {
 		return err
 	}
 
+	// RunSwag runs the swag command to generate the swagger documentation
+	err = RunSwag(goValues.Values.NodeDirectoryName)
+	if err != nil {
+		log.Errorf("err : %s", err)
+		return err
+	}
+	
 	return nil
 }
 

internal/languages/golang/make-proto-runner.go

@@ -40,9 +40,3 @@ func RunMakeProto(directoryName string) error {
 	}
 	return fmt.Errorf("%s command doesn't exist", protocCommand)
 }
-
-// as util
-func commandExists(cmd string) bool {
-	_, err := exec.LookPath(cmd)
-	return err == nil
-}

internal/languages/golang/swag-runner.go

@@ -0,0 +1,38 @@
+package golang
+
+import (
+	"bytes"
+	"fmt"
+	"os/exec"
+
+	log "github.com/sirupsen/logrus"
+)
+
+// RunSwag runs swag with args passed on generated code present in the directory passed.
+func RunSwag(directoryName string) error {
+	swagCommand := "swag"
+	if commandExists(swagCommand) {
+		args := []string{"init", "--parseDependency", "--parseInternal"}
+		command := exec.Command(swagCommand, args...)
+		command.Dir = directoryName
+		var stdErr bytes.Buffer
+		command.Stderr = &stdErr
+		var stdOut bytes.Buffer
+		command.Stdout = &stdOut
+		if err := command.Run(); err != nil {
+			log.Errorf("%s\n", err)
+			log.Errorf("%s\n", stdErr.String())
+			log.Errorf("%s\n", stdOut.String())
+			return err
+		}
+		if len(stdErr.String()) > 0 {
+			log.Errorf("%s\n", stdErr.String())
+		}
+		if len(stdOut.String()) > 0 {
+			log.Infof("%s\n", stdOut.String())
+		}
+		return nil
+	} else {
+		return fmt.Errorf("%s command doesn't exist. Please install swag using https://github.com/swaggo/swag?tab=readme-ov-file#getting-started.\nInstalled, and still facing issue? Please check https://github.com/swaggo/swag/issues/197", swagCommand)
+	}
+}