Fix test cases and update swagger documentation (#32)

- Fixed all failing test cases by correcting mock expectations
- Updated swagger annotations for all API endpoints
- Added missing swagger documentation for product details and update handlers
- Added swagger documentation for health check endpoint
- Fixed swagger comment format issues
- Regenerated complete swagger documentation
- All tests now passing (100% success rate)
- Complete API documentation coverage for all 9 endpoints

Author: MitulShah1

.github/workflows/go.yml

@@ -33,6 +33,12 @@ jobs:
 
     - name: Build
       run: go build -v ./...
+    
+    - name: Run golangci-lint (v2)
+      uses: golangci/golangci-lint-action@v8
+      with:
+        version: v2.1.0
+        args: --verbose  
 
     - name: Test
       run: go test -v ./...

.golangci.yml

@@ -0,0 +1,109 @@
+version: "2"
+run:
+  concurrency: 4  
+linters:
+  default: all
+  disable:
+    - copyloopvar
+    - cyclop
+    - depguard
+    - dupl
+    - err113
+    - errname
+    - errorlint
+    - exhaustive
+    - exhaustruct
+    - forbidigo
+    - forcetypeassert
+    - funlen
+    - gochecknoglobals
+    - gocognit
+    - goconst
+    - gocyclo
+    - godox
+    - godot
+    - gosec
+    - gosmopolitan
+    - inamedparam
+    - interfacebloat
+    - intrange
+    - ireturn
+    - lll
+    - maintidx
+    - mnd
+    - nakedret
+    - nestif
+    - nlreturn
+    - noctx
+    - nonamedreturns
+    - paralleltest
+    - testableexamples
+    - testpackage
+    - testifylint
+    - thelper
+    - tparallel
+    - unparam
+    - usestdlibvars
+    - varnamelen
+    - wrapcheck
+    - wsl
+  settings:
+    gocritic:
+      disabled-checks:
+        - deferInLoop
+        - importShadow
+        - sloppyReassign
+        - unnamedResult
+        - whyNoLint
+      enabled-tags:
+        - diagnostic
+        - experimental
+        - opinionated
+        - performance
+        - style
+    govet:
+      disable:
+        - fieldalignment
+        - shadow
+      enable-all: true
+    lll:
+      line-length: 130
+    revive:
+      rules:
+        - name: indent-error-flow
+        - name: use-any
+    staticcheck:
+      checks:
+        - -ST1000
+        - all
+  exclusions:
+    generated: lax
+    presets:
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    rules:
+      - linters:
+          - lll
+        path: _test\.go
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+      - example/
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+      - example/

cmd/server/main.go

@@ -1,11 +1,9 @@
 package main
 
 import (
-	"github.com/MitulShah1/golang-rest-api-template/package/logger"
-
-	_ "github.com/MitulShah1/golang-rest-api-template/internal/handlers/category/model"
-
 	"github.com/MitulShah1/golang-rest-api-template/config"
+	_ "github.com/MitulShah1/golang-rest-api-template/internal/handlers/category/model"
+	"github.com/MitulShah1/golang-rest-api-template/package/logger"
 )
 
 // @title           REST API Template Example
@@ -30,7 +28,6 @@ import (
 // @externalDocs.description  OpenAPI
 // @externalDocs.url          https://swagger.io/resources/open-api/
 func main() {
-
 	// Initialize the logger
 	log := logger.NewLogger(logger.DefaultOptions())
 
@@ -44,5 +41,4 @@ func main() {
 	if err := config.Run(); err != nil {
 		log.Fatal("error while run app", "error", err.Error())
 	}
-
 }

config/config.go

@@ -1,3 +1,6 @@
+// Package config provides configuration management for the application.
+// It handles loading environment variables, database configuration,
+// server settings, and telemetry configuration.
 package config
 
 import (
@@ -17,7 +20,8 @@ import (
 	tracesdk "go.opentelemetry.io/otel/sdk/trace"
 )
 
-// Config holds application configuration
+// Service holds application configuration and manages the application lifecycle.
+// It includes database, server, and telemetry configuration.
 type Service struct {
 	Name         string
 	Logger       *logger.Logger
@@ -57,17 +61,16 @@ func NewService() *Service {
 // initializing the logger, database connection, and server. It returns an error if any
 // of the initialization steps fail.
 func (cnf *Service) Init() (err error) {
-
-	//initiale logger
+	// initialize logger
 	cnf.Logger = logger.NewLogger(logger.DefaultOptions())
 
-	//Load Env variables
+	// Load environment variables
 	if err := cnf.LoadConfig(); err != nil {
 		return err
 	}
 
-	//initiale database
-	cnf.db, err = database.NewDatabase(database.DBConfig{
+	// initialize database
+	cnf.db, err = database.NewDatabase(&database.DBConfig{
 		Host:     cnf.dbEnv.Host,
 		Port:     cnf.dbEnv.Port,
 		User:     cnf.dbEnv.User,
@@ -95,9 +98,9 @@ func (cnf *Service) Init() (err error) {
 
 	cnf.Logger.Info("Tracer initialized")
 
-	//initiale server
+	// initialize server
 	serverAddr := cnf.srvConfg.Address + ":" + cnf.srvConfg.Port
-	if cnf.Server, err = handlers.NewServer(serverAddr, cnf.Logger, cnf.db, tmCnfg); err != nil {
+	if cnf.Server, err = handlers.NewServer(serverAddr, cnf.Logger, cnf.db, &tmCnfg); err != nil {
 		return err
 	}
 
@@ -108,7 +111,6 @@ func (cnf *Service) Init() (err error) {
 // It runs the server in a goroutine and waits for a termination signal (SIGINT or SIGTERM).
 // When a termination signal is received, it gracefully shuts down the server.
 func (cnf *Service) Run() error {
-
 	// Channel to listen for termination signals
 	stop := make(chan os.Signal, 1)
 	signal.Notify(stop, os.Interrupt, syscall.SIGTERM)
@@ -144,7 +146,7 @@ func (cnf *Service) Run() error {
 }
 
 func (cnf *Service) LoadConfig() error {
-	//loads environment variables from .env file
+	// loads environment variables from .env file
 	if err := godotenv.Load(); err != nil {
 		cnf.Logger.Warn("no .env file found, using system environment variables")
 	}
@@ -157,13 +159,13 @@ func (cnf *Service) LoadConfig() error {
 		Name:     getEnv("DB_NAME", "mydatabase"),
 	}
 
-	//Server config
+	// Server config
 	cnf.srvConfg = ServerConf{
 		Address: getEnv("SERVER_ADDR", ""),
 		Port:    getEnv("SERVER_PORT", "8080"),
 	}
 
-	//Jaeger config
+	// Jaeger config
 	cnf.jaegerConfig = JaegerConfig{
 		AgentHost: getEnv("JAEGER_AGENT_HOST", "localhost"),
 		AgentPort: getEnv("JAEGER_AGENT_PORT", "6831"),