feat: add api for wip/commit

Author: hunjixin

api/api_impl/impl.go

@@ -14,4 +14,6 @@ type APIController struct {
 	controller.VersionController
 	controller.ObjectController
 	controller.UserController
+	controller.WipController
+	controller.CommitController
 }

api/custom_response.go

@@ -9,35 +9,53 @@ type JiaozifsResponse struct {
 	http.ResponseWriter
 }
 
-func (response *JiaozifsResponse) JSON(v interface{}) {
+// JSON convert object to json format and write to response,
+// if not specific code, default code is 200. given code will
+// overwrite default code, if more than one code, the first one will be used.
+func (response *JiaozifsResponse) JSON(v any, code ...int) {
+	if len(code) == 0 {
+		response.WriteHeader(http.StatusOK)
+	} else {
+		response.WriteHeader(code[0])
+	}
 	response.Header().Set("Content-Type", "application/json")
-	response.WriteHeader(http.StatusOK)
-	err := json.NewEncoder(response).Encode(v)
+	err := json.NewEncoder(response.ResponseWriter).Encode(v)
 	if err != nil {
 		response.Error(err)
 		return
 	}
 }
 
+// OK response with 200
 func (response *JiaozifsResponse) OK() {
 	response.WriteHeader(http.StatusOK)
 }
 
+// NotFound response with 404
+func (response *JiaozifsResponse) NotFound() {
+	response.WriteHeader(http.StatusNotFound)
+}
+
+// Error response with 500 and error message
 func (response *JiaozifsResponse) Error(err error) {
 	response.WriteHeader(http.StatusInternalServerError)
 	_, _ = response.Write([]byte(err.Error()))
 }
 
-func (response *JiaozifsResponse) String(msg string) {
+// String response and string
+// if not specific code, default code is 200. given code will
+// overwrite default code, if more than one code, the first one will be used.
+func (response *JiaozifsResponse) String(msg string, code ...int) {
+	if len(code) == 0 {
+		response.WriteHeader(http.StatusOK)
+	} else {
+		response.WriteHeader(code[0])
+	}
 	response.Header().Set("Content-Type", "text/plain;charset=UTF-8")
-	response.WriteHeader(http.StatusOK)
 	_, _ = response.Write([]byte(msg))
 }
 
-func (response *JiaozifsResponse) CodeMsg(code int, msg string) {
-	response.WriteHeader(code)
-	_, _ = response.Write([]byte(msg))
-}
+// Code response with uncommon code
 func (response *JiaozifsResponse) Code(code int) {
 	response.WriteHeader(code)
 }

api/custom_response_test.go

@@ -0,0 +1,104 @@
+package api
+
+import (
+	"fmt"
+	"net/http"
+	"testing"
+
+	"go.uber.org/mock/gomock"
+)
+
+func TestJiaozifsResponse(t *testing.T) {
+	t.Run("not found", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		resp := NewMockResponseWriter(ctrl)
+		jzResp := JiaozifsResponse{resp}
+
+		resp.EXPECT().WriteHeader(http.StatusNotFound)
+		jzResp.NotFound()
+	})
+
+	t.Run("ok", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		resp := NewMockResponseWriter(ctrl)
+		jzResp := JiaozifsResponse{resp}
+
+		resp.EXPECT().WriteHeader(http.StatusOK)
+		jzResp.OK()
+	})
+	t.Run("code", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		resp := NewMockResponseWriter(ctrl)
+		jzResp := JiaozifsResponse{resp}
+
+		resp.EXPECT().WriteHeader(http.StatusCreated)
+		jzResp.Code(http.StatusCreated)
+	})
+	t.Run("error", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		resp := NewMockResponseWriter(ctrl)
+		jzResp := JiaozifsResponse{resp}
+
+		resp.EXPECT().WriteHeader(http.StatusInternalServerError)
+		resp.EXPECT().Write([]byte("mock"))
+		jzResp.Error(fmt.Errorf("mock"))
+	})
+
+	t.Run("string", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		resp := NewMockResponseWriter(ctrl)
+		jzResp := JiaozifsResponse{resp}
+
+		resp.EXPECT().WriteHeader(http.StatusOK)
+		resp.EXPECT().Header().DoAndReturn(func() http.Header {
+			return make(http.Header)
+		})
+		resp.EXPECT().Write([]byte("test"))
+		jzResp.String("test")
+	})
+
+	t.Run("string with code", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		resp := NewMockResponseWriter(ctrl)
+		jzResp := JiaozifsResponse{resp}
+
+		resp.EXPECT().WriteHeader(http.StatusCreated)
+		resp.EXPECT().Header().DoAndReturn(func() http.Header {
+			return make(http.Header)
+		})
+		resp.EXPECT().Write([]byte("test"))
+		jzResp.String("test", http.StatusCreated)
+	})
+
+	t.Run("json", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		resp := NewMockResponseWriter(ctrl)
+		jzResp := JiaozifsResponse{resp}
+
+		resp.EXPECT().WriteHeader(http.StatusOK)
+		resp.EXPECT().Header().DoAndReturn(func() http.Header {
+			return make(http.Header)
+		})
+
+		resp.EXPECT().Write([]byte("{\"Name\":\"aa\"}\n"))
+		jzResp.JSON(struct {
+			Name string
+		}{Name: "aa"})
+	})
+	t.Run("json with code", func(t *testing.T) {
+		ctrl := gomock.NewController(t)
+		resp := NewMockResponseWriter(ctrl)
+		jzResp := JiaozifsResponse{resp}
+
+		resp.EXPECT().WriteHeader(http.StatusCreated)
+		resp.EXPECT().Header().DoAndReturn(func() http.Header {
+			return make(http.Header)
+		})
+
+		resp.EXPECT().Write([]byte("{\"Name\":\"aa\"}\n"))
+		jzResp.JSON(struct {
+			Name string
+		}{Name: "aa"}, http.StatusCreated)
+	})
+
+}

api/docs.go

@@ -2,3 +2,4 @@
 package api
 
 //go:generate go run github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen -package api -templates ./tmpls -generate "types,client,chi-server,spec" -o jiaozifs.gen.go ./swagger.yml
+//go:generate  go run go.uber.org/mock/mockgen@latest --package=api --destination=resp.gen.go net/http ResponseWriter