feat: add dynamic gin json

add dynamic gin json

Author: yuanyu90221

.dockerignore

@@ -0,0 +1,6 @@
+bin
+data
+README.md
+.env
+docker-compose.yml
+Dockerfile

.github/workflows/image.yaml

@@ -0,0 +1,37 @@
+name: Image build
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+  pull_request:
+
+env:
+  IMAGE_NAME: blog-api
+
+jobs:
+
+  push:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build image
+        run: docker compose build blog-api
+      - name: Tag with Image
+        run: docker tag blog-api:latest $IMAGE_NAME:$GITHUB_SHA
+      - name: Log in to registry
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
+      - name: Push to registry
+        run: |
+          IMAGE_ID=ghcr.io/leetcode-golang-classroom/$IMAGE_NAME
+          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+          [ "$VERSION" == "main" ] && VERSION=latest
+          echo IMAGE_ID=$IMAGE_ID
+          echo VERSION=$VERSION
+          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

.gitignore

@@ -0,0 +1,27 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env
+data
+bin

Dockerfile

@@ -0,0 +1,14 @@
+FROM golang:1.22.0 AS build
+WORKDIR /app
+COPY go.mod go.sum Makefile ./
+ADD . ./
+RUN go mod download && make build
+
+FROM build AS test
+RUN make test
+
+FROM alpine as release
+WORKDIR /app
+COPY --from=build /app/bin ./bin
+COPY --from=build /app/template ./template
+CMD ["./bin/main"]

Makefile

@@ -0,0 +1,13 @@
+.PHONY=build
+
+build:
+	@CGO_ENABLED=0 GOOS=linux go build -o bin/main cmd/main.go
+
+run: build
+	@./bin/main
+
+coverage:
+	@go test -v -cover ./...
+
+test:
+	@go test -v ./...

README.md

@@ -0,0 +1,38 @@
+# golang-gin-with-dynamic-json
+
+This repository is for use gin framework to serve dynamic web page
+
+## architecture
+
+![architecture](architecture.png)
+
+## handle pagination with gorm middleware format
+
+```golang
+func Paginate(ctx *gin.Context) func(db *gorm.DB) *gorm.DB {
+	return func(db *gorm.DB) *gorm.DB {
+		pageStr := ctx.DefaultQuery("page", "1")
+		page, _ := strconv.Atoi(pageStr)
+		if page <= 0 {
+			page = 1
+		}
+		pageSizeStr := ctx.DefaultQuery("page_size", "10")
+		pageSize, _ := strconv.Atoi(pageSizeStr)
+		switch {
+		case pageSize > 100:
+			pageSize = 100
+		case pageSize <= 0:
+			pageSize = 10
+		}
+		dbClone := db.Session(&gorm.Session{})
+		var total int64
+		dbClone.Count(&total)
+		totalPages := int(math.Ceil(float64(total) / float64(pageSize)))
+		ctx.Set("page", page)
+		ctx.Set("pageSize", pageSize)
+		ctx.Set("totalPages", totalPages)
+		offset := (page - 1) * pageSize
+		return db.Offset(offset).Limit(pageSize)
+	}
+}
+```

cmd/main.go

@@ -0,0 +1,25 @@
+package main
+
+import (
+	"context"
+	"log"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json/internal/application"
+	"github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json/internal/config"
+)
+
+func main() {
+	app := application.New(config.AppConfig)
+	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM, syscall.SIGINT)
+	defer func() {
+		log.Println("gin-json-http stoping")
+		cancel()
+	}()
+	err := app.Start(ctx)
+	if err != nil {
+		log.Println("failed to start gin-json-http:", err)
+	}
+}

docker-compose.yml

@@ -0,0 +1,56 @@
+services:
+  blog-api:
+    container_name: blog-api
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: release
+    image: blog-api
+    environment:
+      PORT: ${PORT}
+      MYSQL_DATABASE: ${MYSQL_DATABASE}
+      MYSQL_USER: ${MYSQL_USER}
+      MYSQL_PASSWORD: ${MYSQL_PASSWORD}
+      MYSQL_ADDR: db:3306
+      GIN_MODE: release
+    ports:
+      - ${PORT}:${PORT}
+    networks:
+      - mysql
+    depends_on:
+      db:
+        condition: service_healthy
+    logging:
+      driver: json-file
+      options: 
+        max-size: 1k
+        max-file: 3
+  db: 
+    image: mysql:8
+    container_name: mysql
+    restart: always
+    environment:
+      MYSQL_DATABASE: ${MYSQL_DATABASE}
+      MYSQL_USER: ${MYSQL_USER}
+      MYSQL_PASSWORD: ${MYSQL_PASSWORD}
+      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
+    ports:
+      - ${MYSQL_PORT}:${MYSQL_PORT}
+    volumes:
+      - ./data:/var/lib/mysql
+    logging:
+      driver: json-file
+      options: 
+        max-size: 1k
+        max-file: 3
+    networks:
+      - mysql
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost", "-uroot", "-p${MYSQL_ROOT_PASSWORD}"]
+      interval: 5s
+      timeout: 5s
+      retries: 10
+networks:
+  mysql:
+    driver: bridge
+    name: mysql

go.mod

@@ -0,0 +1,60 @@
+module github.com/leetcode-golang-classroom/golang-gin-with-dynamic-json
+
+go 1.21.4
+
+require (
+	github.com/go-sql-driver/mysql v1.7.0
+	github.com/spf13/viper v1.19.0
+	gorm.io/driver/mysql v1.5.7
+	gorm.io/gorm v1.25.11
+)
+
+require (
+	github.com/bytedance/sonic v1.11.6 // indirect
+	github.com/bytedance/sonic/loader v0.1.1 // indirect
+	github.com/cloudwego/base64x v0.1.4 // indirect
+	github.com/cloudwego/iasm v0.2.0 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
+	github.com/gin-contrib/sse v0.1.0 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-playground/validator/v10 v10.20.0 // indirect
+	github.com/goccy/go-json v0.10.2 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/cpuid/v2 v2.2.7 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/ugorji/go/codec v1.2.12 // indirect
+	golang.org/x/arch v0.8.0 // indirect
+	golang.org/x/crypto v0.23.0 // indirect
+	golang.org/x/net v0.25.0 // indirect
+	google.golang.org/protobuf v1.34.1 // indirect
+)
+
+require (
+	github.com/fsnotify/fsnotify v1.7.0 // indirect
+	github.com/gin-gonic/gin v1.10.0
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/sagikazarmark/locafero v0.4.0 // indirect
+	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
+	github.com/sourcegraph/conc v0.3.0 // indirect
+	github.com/spf13/afero v1.11.0 // indirect
+	github.com/spf13/cast v1.6.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/subosito/gotenv v1.6.0 // indirect
+	go.uber.org/atomic v1.9.0 // indirect
+	go.uber.org/multierr v1.9.0 // indirect
+	golang.org/x/exp v0.0.0-20230905200255-921286631fa9 // indirect
+	golang.org/x/sys v0.20.0 // indirect
+	golang.org/x/text v0.15.0 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)