wip

route/route.go

@@ -25,6 +25,8 @@ func InitRouter() *gin.Engine {
 	r.Use(middleware.WriteLog())
 	r.Use(gzip.Gzip(gzip.DefaultCompression))
 	gin.SetMode(config.ServerInfo.RunMode)
+
+	// @tiger - 为了方便未来的模块化迭代，前端输出需要独立端口，不要和 API 端口公用。
 	r.StaticFS("/ui", http.FS(web.Static))
 	r.GET("/", WebUIHome)
 	// r.StaticFS("/assets", http.Dir("./static/assets"))

route/v1/user.go

@@ -31,8 +31,17 @@ import (
 func PostUserRegister(c *gin.Context) {
 	json := make(map[string]string)
 	c.BindJSON(&json)
+
+	// @tiger - user_name 改成 username
 	username := json["user_name"]
 	pwd := json["password"]
+
+	// @tiger - 尽量统一用 JSON 本体来传参。用 query string 来传参的话，
+	// 1 - 有可能会被路由记录，形成不必要的泄露
+	// 2 - 开发者不需要处理两种入参方式
+	//
+	// query string 更加适合运维层面的需求，比如跟踪码，回调地址等
+
 	key := c.Param("key")
 	if _, ok := service.UserRegisterHash[key]; !ok {
 		c.JSON(http.StatusOK,