Implemented Clean Architecture principles

VikashChauhan51 · Jul 21, 2024 · ea0ba88 · ea0ba88
1 parent 8694edc
commit ea0ba88
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,33 @@
 # go-sample-api
-Web api in golang with Gin farmwork
+Web api in golang with Gin farmwork:
+
+GO-SAMPLE-API
+├───.github                # GitHub-specific files
+│   └───workflows          # CI/CD workflows
+├───.vscode                # VSCode-specific files and configurations
+├───cmd                    # Application entry points
+│   └───api                # Main API entry point
+│       └───routes         # Route configurations for the HTTP server
+├───configs                # Configuration files
+├───docs                   # Documentation files
+├───internal               # Private application and library code
+│   ├───controllers        # HTTP handlers
+│   ├───core               # Core business logic
+│   │   ├───entities       # Core business entities
+│   │   ├───interfaces     # Interfaces for dependencies
+│   │   │   ├───repositories  # Repository interfaces
+│   │   │   └───services      # Service interfaces
+│   │   └───usecases       # Business logic use cases
+│   ├───dto                # Data transfer objects (request/response models)
+│   └───infra              # Infrastructure implementations
+│       ├───databases      # Database access implementations
+│       ├───repositories   # Implementations of repository interfaces
+│       └───services       # Implementations of service interfaces
+├───pkg                    # Public library code
+│   └───middlewares        # Custom middleware implementations
+├───test                   # Test-related files
+└───vendor                 # Third-party dependencies (managed by `go mod`)
+
 
 
 ## Update swagger document

diff --git a/cmd/api/main.go b/cmd/api/main.go
@@ -5,8 +5,8 @@ import (
 	"net/http"
 	"time"
 
+	"github.com/VikashChauhan51/go-sample-api/cmd/api/routes"
 	docs "github.com/VikashChauhan51/go-sample-api/docs"
-	"github.com/VikashChauhan51/go-sample-api/internal/routes"
 	"github.com/gin-gonic/gin"
 	swaggerfiles "github.com/swaggo/files"
 	ginSwagger "github.com/swaggo/gin-swagger"

diff --git a/internal/routes/routes.go → cmd/api/routes/routes.go b/internal/routes/routes.go → cmd/api/routes/routes.go
diff --git a/internal/core/interfaces/book_repository.go → ...nterfaces/repositories/book_repository.go b/internal/core/interfaces/book_repository.go → ...nterfaces/repositories/book_repository.go
diff --git a/internal/core/interfaces/book_service.go → .../core/interfaces/services/book_service.go b/internal/core/interfaces/book_service.go → .../core/interfaces/services/book_service.go
diff --git a/internal/core/usecases/.keep b/internal/core/usecases/.keep
diff --git a/internal/models/book.go → internal/dto/book.go b/internal/models/book.go → internal/dto/book.go
@@ -1,7 +1,7 @@
-package models
+package dto
 
 type Book struct {
-	ID     uint   `json:"id" xml:"id" gorm:"primary_key"`
+	ID     uint   `json:"id" xml:"id"`
 	Title  string `json:"title" xml:"title"`
 	Author string `json:"author" xml:"author"`
 }
diff --git a/internal/infra/services/book_service.go b/internal/infra/services/book_service.go
@@ -3,16 +3,16 @@ package services
 import (
 	"time"
 
-	"github.com/VikashChauhan51/go-sample-api/internal/models"
+	"github.com/VikashChauhan51/go-sample-api/internal/dto"
 )
 
 // Simulate fetching books from an external API
-func FetchBooksAsync() ([]models.Book, error) {
+func FetchBooksAsync() ([]dto.Book, error) {
 
-	r := make(chan []models.Book)
+	r := make(chan []dto.Book)
 	go func() {
 		time.Sleep(2 * time.Second) // Simulate external API call
-		books := []models.Book{
+		books := []dto.Book{
 			{ID: 1, Title: "The Lord of the Rings", Author: "J. R. R. Tolkien"},
 			{ID: 2, Title: "Pride and Prejudice", Author: "Jane Austen"},
 			{ID: 3, Title: "To Kill a Mockingbird", Author: "Harper Lee"},