✨ feat: setup basic http router

add default setup

Author: yuanyu90221

.github/workflows/go.yml

@@ -0,0 +1,28 @@
+name: Go
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup go-task
+        uses: pnorton5432/setup-task@v1
+        with:
+          task-version: 3.29.1
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 'stable'
+          check-latest: true
+      - name: Task Build
+        run: task build
+      - name: Task Test
+        run: task test

.gitignore

@@ -0,0 +1,26 @@
+# 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
+bin

README.md

@@ -0,0 +1,269 @@
+# golang-rest-api-sample
+
+This repository is for use golang to implemenation resful api
+
+## setup with server
+
+```golang
+package application
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"net/http"
+	"time"
+
+	"github.com/gin-gonic/gin"
+	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/config"
+)
+
+// define app dependency
+type App struct {
+	Router *gin.Engine
+	config *config.Config
+}
+
+func New(config *config.Config) *App {
+	app := &App{
+		config: config,
+	}
+	app.SetupRoutes()
+	return app
+}
+
+func (app *App) Start(ctx context.Context) error {
+	server := &http.Server{
+		Addr:    fmt.Sprintf(":%s", app.config.Port),
+		Handler: app.Router,
+	}
+	log.Printf("Starting server on %s", app.config.Port)
+	errCh := make(chan error, 1)
+	go func() {
+		err := server.ListenAndServe()
+		if err != nil {
+			errCh <- fmt.Errorf("failed to start server: %w", err)
+		}
+		close(errCh)
+	}()
+
+	select {
+	case err := <-errCh:
+		return err
+	case <-ctx.Done():
+		log.Println("server cancel")
+		timeout, cancel := context.WithTimeout(context.Background(), time.Second*10)
+		defer cancel()
+		return server.Shutdown(timeout)
+	}
+}
+```
+
+## setup application
+```golang
+package main
+
+import (
+	"context"
+	"log"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/application"
+	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/config"
+)
+
+func main() {
+	app := application.New(config.AppConfig)
+	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM, syscall.SIGINT)
+	defer cancel()
+	err := app.Start(ctx)
+	if err != nil {
+		log.Fatalf("failed to start app: %v", err)
+	}
+}
+```
+## setup router
+```golang
+package news
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+)
+
+type Handler struct{}
+
+func NewHandler() *Handler {
+	return &Handler{}
+}
+
+func (h *Handler) RegisterRoute(router *gin.RouterGroup) {
+	router.POST("", h.CreateNews)
+	router.GET("", h.GetAllNews)
+	router.GET("/:id", h.GetNewsByID)
+	router.PUT("/:id", h.UpdateNewsByID)
+	router.DELETE("/:id", h.DeleteNewsByID)
+}
+
+func (h *Handler) CreateNews(ctx *gin.Context) {
+	ctx.Status(http.StatusNotImplemented)
+}
+
+func (h *Handler) GetAllNews(ctx *gin.Context) {
+	ctx.Status(http.StatusNotImplemented)
+}
+
+func (h *Handler) GetNewsByID(ctx *gin.Context) {
+	ctx.Status(http.StatusNotImplemented)
+}
+
+func (h *Handler) UpdateNewsByID(ctx *gin.Context) {
+	ctx.Status(http.StatusNotImplemented)
+}
+
+func (h *Handler) DeleteNewsByID(ctx *gin.Context) {
+	ctx.Status(http.StatusNotImplemented)
+}
+```
+## setup test
+```golang
+package news_test
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/application"
+	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/config"
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_CreateNews(t *testing.T) {
+	testCases := []struct {
+		name           string
+		expectedStatus int
+	}{
+		{
+			name:           "not implemented",
+			expectedStatus: http.StatusNotImplemented,
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			// Arrange test
+			app := application.New(config.AppConfig)
+			app.SetupRoutes()
+
+			w := httptest.NewRecorder()
+			r, _ := http.NewRequest(http.MethodPost, "/news", nil)
+			// Act
+			app.Router.ServeHTTP(w, r)
+			assert.Equalf(t, tc.expectedStatus, w.Code, "expected %v ,got %v", tc.expectedStatus, w.Code)
+		})
+	}
+}
+
+func Test_GetAllNews(t *testing.T) {
+	testCases := []struct {
+		name           string
+		expectedStatus int
+	}{
+		{
+			name:           "not implemented",
+			expectedStatus: http.StatusNotImplemented,
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			// Arrange test
+			app := application.New(config.AppConfig)
+			app.SetupRoutes()
+
+			w := httptest.NewRecorder()
+			r, _ := http.NewRequest(http.MethodGet, "/news", nil)
+			// Act
+			app.Router.ServeHTTP(w, r)
+			assert.Equalf(t, tc.expectedStatus, w.Code, "expected %v ,got %v", tc.expectedStatus, w.Code)
+		})
+	}
+}
+
+func Test_GetNewsById(t *testing.T) {
+	testCases := []struct {
+		name           string
+		expectedStatus int
+	}{
+		{
+			name:           "not implemented",
+			expectedStatus: http.StatusNotImplemented,
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			// Arrange test
+			app := application.New(config.AppConfig)
+			app.SetupRoutes()
+
+			w := httptest.NewRecorder()
+			r, _ := http.NewRequest(http.MethodGet, "/news/1", nil)
+			// Act
+			app.Router.ServeHTTP(w, r)
+			assert.Equalf(t, tc.expectedStatus, w.Code, "expected %v ,got %v", tc.expectedStatus, w.Code)
+		})
+	}
+}
+
+func Test_UpdateNewsByID(t *testing.T) {
+	testCases := []struct {
+		name           string
+		expectedStatus int
+	}{
+		{
+			name:           "not implemented",
+			expectedStatus: http.StatusNotImplemented,
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			// Arrange test
+			app := application.New(config.AppConfig)
+			app.SetupRoutes()
+
+			w := httptest.NewRecorder()
+			r, _ := http.NewRequest(http.MethodPut, "/news/1", nil)
+			// Act
+			app.Router.ServeHTTP(w, r)
+			assert.Equalf(t, tc.expectedStatus, w.Code, "expected %v ,got %v", tc.expectedStatus, w.Code)
+		})
+	}
+}
+
+func Test_DeleteNewsByID(t *testing.T) {
+	testCases := []struct {
+		name           string
+		expectedStatus int
+	}{
+		{
+			name:           "not implemented",
+			expectedStatus: http.StatusNotImplemented,
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			// Arrange test
+			app := application.New(config.AppConfig)
+			app.SetupRoutes()
+
+			w := httptest.NewRecorder()
+			r, _ := http.NewRequest(http.MethodDelete, "/news/1", nil)
+			// Act
+			app.Router.ServeHTTP(w, r)
+			assert.Equalf(t, tc.expectedStatus, w.Code, "expected %v ,got %v", tc.expectedStatus, w.Code)
+		})
+	}
+}
+```

Taskfile.yaml

@@ -0,0 +1,27 @@
+version: '3'
+
+tasks:
+  default:
+    cmds:
+      - echo "This is task cmd"
+    silent: true
+  
+  build:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o bin/main cmd/main.go
+    silent: true
+  run:
+    cmds:
+      - ./bin/main
+    deps:
+      - build
+    silent: true
+  coverage:
+    cmds:
+      - go test -v -cover ./...
+    silent: true
+  test:
+    cmds:
+      - go test -v ./...
+    silent: true
+  

cmd/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"context"
+	"log"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/application"
+	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/config"
+)
+
+func main() {
+	app := application.New(config.AppConfig)
+	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM, syscall.SIGINT)
+	defer cancel()
+	err := app.Start(ctx)
+	if err != nil {
+		log.Fatalf("failed to start app: %v", err)
+	}
+}