feat: replace xml tag name

Author: alovn

examples/docs/apis-demo.md

@@ -173,4 +173,25 @@ __Response__:
 </response>
 ```
 
+```javascript
+//StatusCode: 200 
+<response> //object(common.Response), 通用返回结果
+  <code>0</code> //int, 返回状态码
+  <data> //object(handler.DemoXMLResponse2), XML测试返回对象2
+    <address>abc</address> //string, 地址信息
+    <city_id>123</city_id> //int64, 城市ID
+    <id>123</id> //int64, 地址ID
+  </data>
+  <msg>success</msg> //string, 返回消息
+</response>
+```
+
+```javascript
+//StatusCode: 200 
+<response> //object(common.Response), 通用返回结果
+  <code>10010</code> //int, 返回状态码
+  <msg>sme error</msg> //string, 返回消息
+</response>
+```
+
 ---

examples/svc-greeter/main.go

@@ -75,14 +75,24 @@ type Struct2 struct {
 
 type XMLResponse struct {
 	XMLName xml.Name    `xml:"response"`
-	Attr    int         `json:"attr" xml:"attr,attr"`                //返回状态码
-	Code    int         `json:"code" xml:"code"`                     //返回状态码
-	Msg     string      `json:"msg" xml:"msg"`                       //返回消息
-	Data    interface{} `json:"data,omitempty" xml:"data,omitempty"` //返回具体数据
+	Attr    int         `json:"attr" xml:"attr,attr"` //返回状态码
+	Code    int         `json:"code" xml:"code"`      //返回状态码
+	Msg     string      `json:"msg" xml:"msg"`        //返回消息
+	Data    interface{} //`json:"data,omitempty" xml:"data,omitempty"` //返回具体数据
 	// InnerText string      `xml:",innerxml"`
 	// Arr       []string    `xml:"arr"`
 } //通用返回结果
 
+type XMLData struct {
+	XMLName xml.Name `xml:"mydata"`
+	Title   string
+	Desc    string
+}
+type XMLData2 struct {
+	Title string
+	Desc  string
+}
+
 //@title 测试greeter
 //@api GET /greeter
 //@group greeter
@@ -91,7 +101,8 @@ type XMLResponse struct {
 //@request Request
 //@response1 200 TestData "输出对象"
 //@response1 200 Struct1 "struct1"
-//@response 200 Response{data=TestData} "输出对象 dd"
+//@response 200 XMLResponse{data=[]XMLData} "输出xml"
+//@response 200 XMLResponse{data=[]XMLData2} "输出xml2"
 //@response1 200 common.Response{data=TestData} "输出对象 dd"
 //@response1 500 Response{code=10010,msg="异常"} "出错了"
 //@response1 500 int 错误

examples/svc-user/handler/demo.go

@@ -91,6 +91,11 @@ type DemoXMLResponse struct {
 	CityID  int64    `xml:"city_id"` //城市ID
 	Address string   `xml:"address"` //地址信息
 } //XML测试返回对象
+type DemoXMLResponse2 struct {
+	ID      int64  `xml:"id"`      //地址ID
+	CityID  int64  `xml:"city_id"` //城市ID
+	Address string `xml:"address"` //地址信息
+} //XML测试返回对象2
 
 //@api GET /demo/xml
 //@title XML测试
@@ -99,6 +104,8 @@ type DemoXMLResponse struct {
 //@request DemoXMLRequest
 //@format xml
 //@response 200 common.Response{code=0,msg="success",data=DemoXMLResponse}
+//@response 200 common.Response{code=0,msg="success",data=DemoXMLResponse2}
+//@response 200 common.Response{code=10010,msg="sme error"}
 //@author alovn
 func (h *AddressHandler) XML(w http.ResponseWriter, r *http.Request) {
 	address := DemoXMLRequest{}

operation.go

@@ -285,6 +285,16 @@ func (operation *Operation) parseCombinedObject(refType string, astFile *ast.Fil
 					return nil, err
 				}
 				key := strings.ToLower(keyVal[0])
+				if old, ok := schemaA.Properties[key]; ok { //xml tag replace
+					xmlTag, hasTag, isAttr, _, isInner := old.XMLTag()
+					if _, has2 := schema.hasXMLName(); !has2 {
+						if hasTag && !isAttr && !isInner {
+							schema.xmlName = xmlTag
+						} else {
+							schema.xmlName = old.Name
+						}
+					}
+				}
 				if isArray {
 					arrSchema := &TypeSchema{
 						Name:        key,

spec.go

@@ -77,6 +77,7 @@ type ApiResponseSpec struct {
 	Format      string //json xml
 	Schema      *TypeSchema
 	Description string
+	body        string //cache
 }
 
 type TypeSchema struct {
@@ -93,6 +94,7 @@ type TypeSchema struct {
 	typeSpecDef   *TypeSpecDef
 	example       string //example value
 	parameterTags map[string]string
+	xmlName       string
 }
 
 func (s *ApiRequestSpec) Body() string {
@@ -110,7 +112,11 @@ func (s *ApiResponseSpec) Body() string {
 	if s.Schema == nil {
 		return ""
 	}
-	return s.Schema.Write(s.Format)
+	if s.body != "" {
+		return s.body
+	}
+	s.body = s.Schema.Write(s.Format)
+	return s.body
 }
 
 func (s *TypeSchema) Write(format string) string {
@@ -249,7 +255,7 @@ func (s *TypeSchema) parseXML(depth int, sb *strings.Builder, isNewLine bool) {
 			if v.Name == "XMLName" && v.FullName == "xml.Name" { //ignore xmlname
 				continue
 			}
-			key, isAttr, isOmitempty, isInner := v.XMLTag()
+			key, _, isAttr, isOmitempty, isInner := v.XMLTag()
 			if isAttr { //ignore attr
 				continue
 			}
@@ -407,7 +413,29 @@ func (v *TypeSchema) ValidateTag() (validate string) {
 	return
 }
 
+func (v *TypeSchema) hasXMLName() (xmlName string, has bool) {
+	if v.xmlName != "" {
+		return v.xmlName, true
+	}
+	if v.Properties != nil {
+		if x, ok := v.Properties["xmlname"]; ok {
+			if x.Name == "XMLName" && x.FullName == "xml.Name" {
+				val, has2 := x.GetTag("xml")
+				if has2 {
+					xmlName = strings.Split(val, ",")[0]
+					has = true
+					return
+				}
+			}
+		}
+	}
+	return "", false
+}
+
 func (v *TypeSchema) XMLName() string {
+	if v.xmlName != "" {
+		return v.xmlName
+	}
 	if v.Properties != nil {
 		if x, ok := v.Properties["xmlname"]; ok {
 			if x.Name == "XMLName" && x.FullName == "xml.Name" {
@@ -428,7 +456,7 @@ func (v *TypeSchema) XMLAttrs() map[string]string {
 			if schema.Name == "XMLName" && schema.FullName == "xml.Name" {
 				continue
 			}
-			xmlTag, isAttr, _, _ := schema.XMLTag()
+			xmlTag, _, isAttr, _, _ := schema.XMLTag()
 			if isAttr {
 				m[xmlTag] = schema.ExampleValue()
 			}
@@ -438,12 +466,13 @@ func (v *TypeSchema) XMLAttrs() map[string]string {
 	return nil
 }
 
-func (v *TypeSchema) XMLTag() (xmlTag string, isAttr, isOmitempty, isInner bool) {
+func (v *TypeSchema) XMLTag() (xmlTag string, hasTag, isAttr, isOmitempty, isInner bool) {
 	val, has := v.GetTag("xml")
 	if has {
 		arr := strings.Split(val, ",")
 		if len(arr) > 0 {
 			xmlTag = arr[0]
+			hasTag = xmlTag != "" && xmlTag != "-"
 			for i, a := range arr {
 				if i == 0 {
 					continue
@@ -460,7 +489,7 @@ func (v *TypeSchema) XMLTag() (xmlTag string, isAttr, isOmitempty, isInner bool)
 			return
 		}
 	}
-	return v.Name, false, false, false
+	return v.Name, false, false, false, false
 }
 
 func getFieldExample(typeName string, field *ast.Field) string {