feat(swagger): support wrapCodeMsgMapping

Author: jaronnie

tools/goctl/api/swagger/const.go

@@ -57,9 +57,11 @@ const (
 	propertyKeyHost                    = "host"
 	propertyKeyBasePath                = "basePath"
 	propertyKeyWrapCodeMsg             = "wrapCodeMsg"
+	propertyKeyWrapCodeMsgMapping      = "wrapCodeMsgMapping"
 	propertyKeyBizCodeEnumDescription  = "bizCodeEnumDescription"
 )
 
 const (
-	defaultValueOfPropertyUseDefinition = false
+	defaultValueOfPropertyUseDefinition      = false
+	defaultValueOfPropertyWrapCodeMsgMapping = `{"code":"code", "data":"data", "msg":"msg"}`
 )

tools/goctl/api/swagger/context.go

@@ -9,6 +9,7 @@ import (
 type Context struct {
 	UseDefinitions         bool
 	WrapCodeMsg            bool
+	WrapCodeMsgMapping     string
 	BizCodeEnumDescription string
 }
 
@@ -23,6 +24,7 @@ func contextFromApi(info spec.Info) Context {
 	return Context{
 		UseDefinitions:         getBoolFromKVOrDefault(info.Properties, propertyKeyUseDefinitions, defaultValueOfPropertyUseDefinition),
 		WrapCodeMsg:            getBoolFromKVOrDefault(info.Properties, propertyKeyWrapCodeMsg, false),
+		WrapCodeMsgMapping:     getStringFromKVOrDefault(info.Properties, propertyKeyWrapCodeMsgMapping, defaultValueOfPropertyWrapCodeMsgMapping),
 		BizCodeEnumDescription: getStringFromKVOrDefault(info.Properties, propertyKeyBizCodeEnumDescription, "business code"),
 	}
 }

tools/goctl/api/swagger/swagger.go

@@ -259,12 +259,24 @@ func wrapCodeMsgProps(ctx Context, properties spec.SchemaProps, atDoc apiSpec.At
 	if !ctx.WrapCodeMsg {
 		return properties
 	}
+
+	type WrapCodeMsgMapping struct {
+		Code string `json:"code"`
+		Data string `json:"data"`
+		Msg  string `json:"msg"`
+	}
+
+	var wrapCodeMsgMapping WrapCodeMsgMapping
+	if err := json.Unmarshal([]byte(ctx.WrapCodeMsgMapping), &wrapCodeMsgMapping); err != nil {
+		return properties
+	}
+
 	globalCodeDesc := ctx.BizCodeEnumDescription
 	methodCodeDesc := getStringFromKVOrDefault(atDoc.Properties, propertyKeyBizCodeEnumDescription, globalCodeDesc)
 	return spec.SchemaProps{
 		Type: []string{swaggerTypeObject},
 		Properties: spec.SchemaProperties{
-			"code": {
+			wrapCodeMsgMapping.Code: {
 				SwaggerSchemaProps: spec.SwaggerSchemaProps{
 					Example: 0,
 				},
@@ -273,7 +285,7 @@ func wrapCodeMsgProps(ctx Context, properties spec.SchemaProps, atDoc apiSpec.At
 					Description: methodCodeDesc,
 				},
 			},
-			"msg": {
+			wrapCodeMsgMapping.Msg: {
 				SwaggerSchemaProps: spec.SwaggerSchemaProps{
 					Example: "ok",
 				},
@@ -282,7 +294,7 @@ func wrapCodeMsgProps(ctx Context, properties spec.SchemaProps, atDoc apiSpec.At
 					Description: "business message",
 				},
 			},
-			"data": {
+			wrapCodeMsgMapping.Data: {
 				SchemaProps: properties,
 			},
 		},