add

Author: confucianzuoyuan

基于Go语言构建企业级的RESTful-API服务/README.md

@@ -0,0 +1,3 @@
+clean:
+	find . -name "[._]*.s[a-w][a-z]" | xargs -i rm -f {} 
+.PHONY: clean

基于Go语言构建企业级的RESTful-API服务/apiserver_demos/Makefile

@@ -0,0 +1,19 @@
+## 目录
+
++ demo01：实战：启动一个最简单的 RESTful API 服务器
++ demo02：实战：配置文件读取
++ demo03：实战：记录和管理API日志
++ demo04：实战：初始化Mysql数据库并建立连接
++ demo05：实战：自定义业务错误信息
++ demo06：实战：读取和返回HTTP请求
++ demo07：实战：用户业务逻辑处理（业务处理）
++ demo08：实战：HTTP调用添加自定义处理逻辑
++ demo09：实战：API身份验证
++ demo10：进阶：用HTTPS加密API请求
++ demo11：进阶：用Makefile管理API项目
++ demo12：进阶：给API命令增加版本功能
++ demo13：进阶：给API增加启动脚本
++ demo14：进阶：基于Nginx的API部署方案
++ demo15：进阶：go test测试你的代码
++ demo16：进阶：API性能分析
++ demo17：进阶：生成Swagger在线文档

基于Go语言构建企业级的RESTful-API服务/apiserver_demos/README.md

@@ -0,0 +1 @@
+实战：启动一个最简单的RESTful API服务器

基于Go语言构建企业级的RESTful-API服务/apiserver_demos/demo01/README.md

@@ -0,0 +1,99 @@
+package sd
+
+import (
+	"fmt"
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+	"github.com/shirou/gopsutil/cpu"
+	"github.com/shirou/gopsutil/disk"
+	"github.com/shirou/gopsutil/load"
+	"github.com/shirou/gopsutil/mem"
+)
+
+const (
+	B  = 1
+	KB = 1024 * B
+	MB = 1024 * KB
+	GB = 1024 * MB
+)
+
+// HealthCheck shows `OK` as the ping-pong result.
+func HealthCheck(c *gin.Context) {
+	message := "OK"
+	c.String(http.StatusOK, "\n"+message)
+}
+
+// DiskCheck checks the disk usage.
+func DiskCheck(c *gin.Context) {
+	u, _ := disk.Usage("/")
+
+	usedMB := int(u.Used) / MB
+	usedGB := int(u.Used) / GB
+	totalMB := int(u.Total) / MB
+	totalGB := int(u.Total) / GB
+	usedPercent := int(u.UsedPercent)
+
+	status := http.StatusOK
+	text := "OK"
+
+	if usedPercent >= 95 {
+		status = http.StatusOK
+		text = "CRITICAL"
+	} else if usedPercent >= 90 {
+		status = http.StatusTooManyRequests
+		text = "WARNING"
+	}
+
+	message := fmt.Sprintf("%s - Free space: %dMB (%dGB) / %dMB (%dGB) | Used: %d%%", text, usedMB, usedGB, totalMB, totalGB, usedPercent)
+	c.String(status, "\n"+message)
+}
+
+// CPUCheck checks the cpu usage.
+func CPUCheck(c *gin.Context) {
+	cores, _ := cpu.Counts(false)
+
+	a, _ := load.Avg()
+	l1 := a.Load1
+	l5 := a.Load5
+	l15 := a.Load15
+
+	status := http.StatusOK
+	text := "OK"
+
+	if l5 >= float64(cores-1) {
+		status = http.StatusInternalServerError
+		text = "CRITICAL"
+	} else if l5 >= float64(cores-2) {
+		status = http.StatusTooManyRequests
+		text = "WARNING"
+	}
+
+	message := fmt.Sprintf("%s - Load average: %.2f, %.2f, %.2f | Cores: %d", text, l1, l5, l15, cores)
+	c.String(status, "\n"+message)
+}
+
+// RAMCheck checks the disk usage.
+func RAMCheck(c *gin.Context) {
+	u, _ := mem.VirtualMemory()
+
+	usedMB := int(u.Used) / MB
+	usedGB := int(u.Used) / GB
+	totalMB := int(u.Total) / MB
+	totalGB := int(u.Total) / GB
+	usedPercent := int(u.UsedPercent)
+
+	status := http.StatusOK
+	text := "OK"
+
+	if usedPercent >= 95 {
+		status = http.StatusInternalServerError
+		text = "CRITICAL"
+	} else if usedPercent >= 90 {
+		status = http.StatusTooManyRequests
+		text = "WARNING"
+	}
+
+	message := fmt.Sprintf("%s - Free space: %dMB (%dGB) / %dMB (%dGB) | Used: %d%%", text, usedMB, usedGB, totalMB, totalGB, usedPercent)
+	c.String(status, "\n"+message)
+}

基于Go语言构建企业级的RESTful-API服务/apiserver_demos/demo01/handler/sd/check.go

@@ -0,0 +1,55 @@
+package main
+
+import (
+	"errors"
+	"log"
+	"net/http"
+	"time"
+
+	"apiserver/router"
+
+	"github.com/gin-gonic/gin"
+)
+
+func main() {
+	// Create the Gin engine.
+	g := gin.New()
+
+	middlewares := []gin.HandlerFunc{}
+
+	// Routes.
+	router.Load(
+		// Cores.
+		g,
+
+		// Middlwares.
+		middlewares...,
+	)
+
+	// Ping the server to make sure the router is working.
+	go func() {
+		if err := pingServer(); err != nil {
+			log.Fatal("The router has no response, or it might took too long to start up.", err)
+		}
+		log.Print("The router has been deployed successfully.")
+	}()
+
+	log.Printf("Start to listening the incoming requests on http address: %s", ":8080")
+	log.Printf(http.ListenAndServe(":8080", g).Error())
+}
+
+// pingServer pings the http server to make sure the router is working.
+func pingServer() error {
+	for i := 0; i < 2; i++ {
+		// Ping the server by sending a GET request to `/health`.
+		resp, err := http.Get("http://127.0.0.1:8080" + "/sd/health")
+		if err == nil && resp.StatusCode == 200 {
+			return nil
+		}
+
+		// Sleep for a second to continue the next ping.
+		log.Print("Waiting for the router, retry in 1 second.")
+		time.Sleep(time.Second)
+	}
+	return errors.New("Cannot connect to the router.")
+}

基于Go语言构建企业级的RESTful-API服务/apiserver_demos/demo01/main.go

@@ -0,0 +1,48 @@
+package middleware
+
+import (
+	"net/http"
+	"time"
+
+	"github.com/gin-gonic/gin"
+)
+
+// NoCache is a middleware function that appends headers
+// to prevent the client from caching the HTTP response.
+func NoCache(c *gin.Context) {
+	c.Header("Cache-Control", "no-cache, no-store, max-age=0, must-revalidate, value")
+	c.Header("Expires", "Thu, 01 Jan 1970 00:00:00 GMT")
+	c.Header("Last-Modified", time.Now().UTC().Format(http.TimeFormat))
+	c.Next()
+}
+
+// Options is a middleware function that appends headers
+// for options requests and aborts then exits the middleware
+// chain and ends the request.
+func Options(c *gin.Context) {
+	if c.Request.Method != "OPTIONS" {
+		c.Next()
+	} else {
+		c.Header("Access-Control-Allow-Origin", "*")
+		c.Header("Access-Control-Allow-Methods", "GET,POST,PUT,PATCH,DELETE,OPTIONS")
+		c.Header("Access-Control-Allow-Headers", "authorization, origin, content-type, accept")
+		c.Header("Allow", "HEAD,GET,POST,PUT,PATCH,DELETE,OPTIONS")
+		c.Header("Content-Type", "application/json")
+		c.AbortWithStatus(200)
+	}
+}
+
+// Secure is a middleware function that appends security
+// and resource access headers.
+func Secure(c *gin.Context) {
+	c.Header("Access-Control-Allow-Origin", "*")
+	c.Header("X-Frame-Options", "DENY")
+	c.Header("X-Content-Type-Options", "nosniff")
+	c.Header("X-XSS-Protection", "1; mode=block")
+	if c.Request.TLS != nil {
+		c.Header("Strict-Transport-Security", "max-age=31536000")
+	}
+
+	// Also consider adding Content-Security-Policy headers
+	// c.Header("Content-Security-Policy", "script-src 'self' https://cdnjs.cloudflare.com")
+}

基于Go语言构建企业级的RESTful-API服务/apiserver_demos/demo01/router/middleware/header.go

@@ -0,0 +1,35 @@
+package router
+
+import (
+	"net/http"
+
+	"apiserver/handler/sd"
+	"apiserver/router/middleware"
+
+	"github.com/gin-gonic/gin"
+)
+
+// Load loads the middlewares, routes, handlers.
+func Load(g *gin.Engine, mw ...gin.HandlerFunc) *gin.Engine {
+	// Middlewares.
+	g.Use(gin.Recovery())
+	g.Use(middleware.NoCache)
+	g.Use(middleware.Options)
+	g.Use(middleware.Secure)
+	g.Use(mw...)
+	// 404 Handler.
+	g.NoRoute(func(c *gin.Context) {
+		c.String(http.StatusNotFound, "The incorrect API route.")
+	})
+
+	// The health check handlers
+	svcd := g.Group("/sd")
+	{
+		svcd.GET("/health", sd.HealthCheck)
+		svcd.GET("/disk", sd.DiskCheck)
+		svcd.GET("/cpu", sd.CPUCheck)
+		svcd.GET("/ram", sd.RAMCheck)
+	}
+
+	return g
+}

基于Go语言构建企业级的RESTful-API服务/apiserver_demos/demo01/router/router.go

@@ -0,0 +1 @@
+实战：配置文件读取

基于Go语言构建企业级的RESTful-API服务/apiserver_demos/demo02/README.md

@@ -0,0 +1,5 @@
+runmode: debug                 # 开发模式, debug, release, test
+addr: :8080                  # HTTP绑定端口
+name: apiserver              # API Server的名字
+url: http://127.0.0.1:8080   # pingServer函数请求的API服务器的ip:port
+max_ping_count: 10           # pingServer函数try的次数