fix: 统一业务响应状态码约定
This commit is contained in:
+16
-20
@@ -25,27 +25,25 @@ func NewController() *Controller { return &Controller{} }
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param body body Credentials true "注册信息"
|
||||
// @Success 201 {object} utils.APIResponse{data=UserResponse}
|
||||
// @Failure 400 {object} utils.APIResponse
|
||||
// @Failure 409 {object} utils.APIResponse
|
||||
// @Success 200 {object} utils.APIResponse{data=UserResponse}
|
||||
// @Router /auth/register [post]
|
||||
func (c *Controller) Register(ctx *gin.Context) {
|
||||
var input Credentials
|
||||
if err := ctx.ShouldBindJSON(&input); err != nil {
|
||||
ctx.JSON(http.StatusBadRequest, utils.Failure(400, err.Error()))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(400, err.Error()))
|
||||
return
|
||||
}
|
||||
hash, err := bcrypt.GenerateFromPassword([]byte(input.Password), bcrypt.DefaultCost)
|
||||
if err != nil {
|
||||
ctx.JSON(http.StatusInternalServerError, utils.Failure(500, "密码处理失败"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(500, "密码处理失败"))
|
||||
return
|
||||
}
|
||||
user := models.User{Username: input.Username, Password: string(hash)}
|
||||
if err := database.GetDB().Create(&user).Error; err != nil {
|
||||
ctx.JSON(http.StatusConflict, utils.Failure(409, "用户名已存在或数据无效"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(409, "用户名已存在或数据无效"))
|
||||
return
|
||||
}
|
||||
ctx.JSON(http.StatusCreated, utils.Success(UserResponse{ID: user.ID, Username: user.Username}))
|
||||
ctx.JSON(http.StatusOK, utils.Success(UserResponse{ID: user.ID, Username: user.Username}))
|
||||
}
|
||||
|
||||
// Login godoc
|
||||
@@ -55,31 +53,30 @@ func (c *Controller) Register(ctx *gin.Context) {
|
||||
// @Produce json
|
||||
// @Param body body Credentials true "登录信息"
|
||||
// @Success 200 {object} utils.APIResponse{data=middlewares.TokenPair}
|
||||
// @Failure 401 {object} utils.APIResponse
|
||||
// @Router /auth/login [post]
|
||||
func (c *Controller) Login(ctx *gin.Context) {
|
||||
var input Credentials
|
||||
if err := ctx.ShouldBindJSON(&input); err != nil {
|
||||
ctx.JSON(http.StatusBadRequest, utils.Failure(400, err.Error()))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(400, err.Error()))
|
||||
return
|
||||
}
|
||||
var user models.User
|
||||
err := database.GetDB().Where("username = ?", input.Username).First(&user).Error
|
||||
if errors.Is(err, gorm.ErrRecordNotFound) {
|
||||
ctx.JSON(http.StatusUnauthorized, utils.Failure(401, "用户名或密码错误"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(401, "用户名或密码错误"))
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
ctx.JSON(http.StatusInternalServerError, utils.Failure(500, "查询用户失败"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(500, "查询用户失败"))
|
||||
return
|
||||
}
|
||||
if bcrypt.CompareHashAndPassword([]byte(user.Password), []byte(input.Password)) != nil {
|
||||
ctx.JSON(http.StatusUnauthorized, utils.Failure(401, "用户名或密码错误"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(401, "用户名或密码错误"))
|
||||
return
|
||||
}
|
||||
pair, err := middlewares.GenerateTokenPair(int(user.ID), user.Username)
|
||||
if err != nil {
|
||||
ctx.JSON(http.StatusInternalServerError, utils.Failure(500, "生成 token 失败"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(500, "生成 token 失败"))
|
||||
return
|
||||
}
|
||||
ctx.JSON(http.StatusOK, utils.Success(pair))
|
||||
@@ -92,31 +89,30 @@ func (c *Controller) Login(ctx *gin.Context) {
|
||||
// @Produce json
|
||||
// @Param body body RefreshRequest true "Refresh Token"
|
||||
// @Success 200 {object} utils.APIResponse{data=middlewares.TokenPair}
|
||||
// @Failure 401 {object} utils.APIResponse
|
||||
// @Router /auth/refresh [post]
|
||||
func (c *Controller) Refresh(ctx *gin.Context) {
|
||||
var input RefreshRequest
|
||||
if err := ctx.ShouldBindJSON(&input); err != nil {
|
||||
ctx.JSON(http.StatusBadRequest, utils.Failure(400, err.Error()))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(400, err.Error()))
|
||||
return
|
||||
}
|
||||
claims, err := middlewares.ParseToken(input.RefreshToken)
|
||||
if err != nil || claims.TokenType != middlewares.TokenTypeRefresh {
|
||||
ctx.JSON(http.StatusUnauthorized, utils.Failure(401, "refresh token 无效或已过期"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(401, "refresh token 无效或已过期"))
|
||||
return
|
||||
}
|
||||
revoked, err := database.IsTokenRevoked(ctx.Request.Context(), claims.ID)
|
||||
if err != nil || revoked {
|
||||
ctx.JSON(http.StatusUnauthorized, utils.Failure(401, "refresh token 已撤销"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(401, "refresh token 已撤销"))
|
||||
return
|
||||
}
|
||||
if err := revokeClaims(ctx, claims); err != nil {
|
||||
ctx.JSON(http.StatusInternalServerError, utils.Failure(500, "撤销旧 token 失败"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(500, "撤销旧 token 失败"))
|
||||
return
|
||||
}
|
||||
pair, err := middlewares.GenerateTokenPair(claims.UserID, claims.Username)
|
||||
if err != nil {
|
||||
ctx.JSON(http.StatusInternalServerError, utils.Failure(500, "生成 token 失败"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(500, "生成 token 失败"))
|
||||
return
|
||||
}
|
||||
ctx.JSON(http.StatusOK, utils.Success(pair))
|
||||
@@ -134,7 +130,7 @@ func (c *Controller) Refresh(ctx *gin.Context) {
|
||||
func (c *Controller) Logout(ctx *gin.Context) {
|
||||
claims, _ := middlewares.GetCurrentClaims(ctx)
|
||||
if err := revokeClaims(ctx, claims); err != nil {
|
||||
ctx.JSON(http.StatusInternalServerError, utils.Failure(500, "撤销 access token 失败"))
|
||||
ctx.JSON(http.StatusOK, utils.Failure(500, "撤销 access token 失败"))
|
||||
return
|
||||
}
|
||||
var input LogoutRequest
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
//go:build cgo
|
||||
|
||||
package auth
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"skeleton/config"
|
||||
"skeleton/database"
|
||||
"skeleton/middlewares"
|
||||
"skeleton/models"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
"go.uber.org/zap"
|
||||
)
|
||||
|
||||
func TestBusinessErrorsUseHTTP200(t *testing.T) {
|
||||
cfg := config.DatabaseConfig{Driver: "sqlite", DSN: ":memory:", MaxIdleConns: 1, MaxOpenConns: 1}
|
||||
if err := database.Init(&cfg, zap.NewNop()); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
t.Cleanup(func() { _ = database.Close() })
|
||||
if err := database.GetDB().AutoMigrate(&models.User{}); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
middlewares.InitJWT("test-secret", 15, 24, "test")
|
||||
|
||||
gin.SetMode(gin.TestMode)
|
||||
controller := NewController()
|
||||
router := gin.New()
|
||||
router.POST("/register", controller.Register)
|
||||
router.POST("/login", controller.Login)
|
||||
|
||||
assertBusinessResponse(t, router, "/register", `{"username":"x","password":"short"}`, 400)
|
||||
assertBusinessResponse(t, router, "/register", `{"username":"demo","password":"change-me-123"}`, 200)
|
||||
assertBusinessResponse(t, router, "/login", `{"username":"demo","password":"wrong-password"}`, 401)
|
||||
}
|
||||
|
||||
func assertBusinessResponse(t *testing.T, handler http.Handler, path, body string, wantCode int) {
|
||||
t.Helper()
|
||||
request := httptest.NewRequest(http.MethodPost, path, bytes.NewBufferString(body))
|
||||
request.Header.Set("Content-Type", "application/json")
|
||||
recorder := httptest.NewRecorder()
|
||||
handler.ServeHTTP(recorder, request)
|
||||
if recorder.Code != http.StatusOK {
|
||||
t.Fatalf("HTTP status = %d, want 200; body=%s", recorder.Code, recorder.Body.String())
|
||||
}
|
||||
var response struct {
|
||||
Code int `json:"code"`
|
||||
}
|
||||
if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if response.Code != wantCode {
|
||||
t.Fatalf("business code = %d, want %d; body=%s", response.Code, wantCode, recorder.Body.String())
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user