fix: template request body empty, support add group attr at file doc …

…comment
alovn · May 19, 2022 · a990865 · a990865
1 parent 7fee8d4
commit a990865
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 9 deletions.
diff --git a/gen/template/apidocs/group_apis.tpl b/gen/template/apidocs/group_apis.tpl
@@ -51,6 +51,7 @@ parameter|parameterType|dataType|required|validate|example|description
 {{- range $p:= $v.Requests.Parameters}}
 __{{$p.Name}}__|_{{$p.ParameterTypes}}_|{{$p.DataType}}|{{$p.Required}}|{{$p.Validate}}|{{$p.Example}}|{{$p.Description}}
 {{- end}}
+{{- end}}
 {{- if $v.Requests.Body}}
 
 _body_:
@@ -59,7 +60,6 @@ _body_:
 {{$v.Requests.Body}}
 ```
 {{- end}}
-{{- end}}
 {{- if $v.Responses}}
 
 __Response__:

diff --git a/gen/template/apidocs/single_index.tpl b/gen/template/apidocs/single_index.tpl
@@ -54,6 +54,7 @@ parameter|parameterType|dataType|required|validate|example|description
 {{- range $p:= $v.Requests.Parameters}}
 __{{$p.Name}}__|_{{$p.ParameterTypes}}_|{{$p.DataType}}|{{$p.Required}}|{{$p.Validate}}|{{$p.Example}}|{{$p.Description}}
 {{- end}}
+{{- end}}
 {{- if $v.Requests.Body}}
 
 _body_:
@@ -62,7 +63,6 @@ _body_:
 {{$v.Requests.Body}}
 ```
 {{- end}}
-{{- end}}
 {{- if $v.Responses}}
 
 __Response__:

diff --git a/gen/template/markdown/group_apis.tpl b/gen/template/markdown/group_apis.tpl
@@ -44,6 +44,7 @@ parameter|parameterType|dataType|required|validate|example|description
 {{- range $p:= $v.Requests.Parameters}}
 __{{$p.Name}}__|_{{$p.ParameterTypes}}_|{{$p.DataType}}|{{$p.Required}}|{{$p.Validate}}|{{$p.Example}}|{{$p.Description}}
 {{- end}}
+{{- end}}
 {{- if $v.Requests.Body}}
 
 _body_:
@@ -52,7 +53,7 @@ _body_:
 {{$v.Requests.Body}}
 ```
 {{- end}}
-{{- end}}
+
 {{- if $v.Responses}}
 
 __Response__:

diff --git a/gen/template/markdown/single_index.tpl b/gen/template/markdown/single_index.tpl
@@ -54,6 +54,7 @@ parameter|parameterType|dataType|required|validate|example|description
 {{- range $p:= $v.Requests.Parameters}}
 __{{$p.Name}}__|_{{$p.ParameterTypes}}_|{{$p.DataType}}|{{$p.Required}}|{{$p.Validate}}|{{$p.Example}}|{{$p.Description}}
 {{- end}}
+{{- end}}
 {{- if $v.Requests.Body}}
 
 _body_:
@@ -62,7 +63,6 @@ _body_:
 {{$v.Requests.Body}}
 ```
 {{- end}}
-{{- end}}
 {{- if $v.Responses}}
 
 __Response__:

diff --git a/parser/parser.go b/parser/parser.go
@@ -105,6 +105,22 @@ func (p *Parser) GetApiDoc() *ApiDocSpec {
 
 func (p *Parser) parseApiInfos(fileName string, astFile *ast.File) error {
 	//parse group
+	var fileGroup string
+	comments := strings.Split(astFile.Doc.Text(), "\n")
+	if len(comments) > 0 {
+		for _, comment := range comments {
+			commentLine := strings.TrimSpace(strings.TrimLeft(comment, "/"))
+			if len(commentLine) == 0 {
+				continue
+			}
+			attribute := strings.Fields(commentLine)[0]
+			lineRemainder, lowerAttribute := strings.TrimSpace(commentLine[len(attribute):]), strings.ToLower(attribute)
+			if lowerAttribute == groupAttr {
+				fileGroup = lineRemainder
+				break
+			}
+		}
+	}
 	for _, comment := range astFile.Comments {
 		comments := strings.Split(comment.Text(), "\n")
 		if isApiGroupComment(comments) {
@@ -141,7 +157,10 @@ func (p *Parser) parseApiInfos(fileName string, astFile *ast.File) error {
 						return fmt.Errorf("ParseComment error in file %s :%+v", fileName, err)
 					}
 				}
-				operation.ApiSpec.doc = p.doc //ptr, for build full url
+				operation.ApiSpec.doc = p.doc                         //ptr, for build full url
+				if operation.ApiSpec.Group == "" && fileGroup != "" { //use file group
+					operation.ApiSpec.Group = fileGroup
+				}
 				if operation.ApiSpec.Group == "" {
 					p.doc.UngroupedApis = append(p.doc.UngroupedApis, &operation.ApiSpec)
 				} else {

diff --git a/parser/spec.go b/parser/spec.go
@@ -325,8 +325,15 @@ func (v *TypeSchema) buildComment() string {
 	} else {
 		s += v.Type
 	}
-	if v.IsRequired() {
-		s += ", required"
+
+	validate := v.ValidateTag()
+	if validate != "" && !strings.Contains(validate, "required") {
+		if v.IsRequired() {
+			s += ", required"
+		}
+	}
+	if validate != "" {
+		s += fmt.Sprintf(", validate:\"%s\"", validate)
 	}
 	if len(v.Comment) > 0 {
 		s += ", " + v.Comment
@@ -553,7 +560,7 @@ func getTypeExample(typeName, example string) string {
 
 func exampleInt(example string) int {
 	if example == "" {
-		return 123
+		return 0
 	}
 	v, _ := strconv.Atoi(example)
 	return v
@@ -592,7 +599,7 @@ func exampleBool(example string) bool {
 
 func exampleString(example string) string {
 	if example == "" {
-		return "abc"
+		return "string"
 	}
 	return example
 }