Merge pull request #350 from go-generalize/fix/swaggo-get-doc

Fix swaggo get doc

Author: 54m

pkg/server/swaggen.go

@@ -33,7 +33,9 @@ func (g *Generator) generateSwagComment(ep *parser.Endpoint) string {
 	for k, v := range obj.Entries {
 		t, attrs := getSwagType(v.Type)
 
-		param, ok := reflect.StructTag(v.RawTag).Lookup("param")
+		structTag := reflect.StructTag(v.RawTag)
+
+		param, ok := structTag.Lookup("param")
 		if !ok {
 			param = k
 		}
@@ -45,7 +47,11 @@ func (g *Generator) generateSwagComment(ep *parser.Endpoint) string {
 		if _, ok := placeholders[param]; ok {
 			params = append(params, fmt.Sprintf(`// @Param %s path %s %v "%s"%s`+"\n", param, t, true, k, attrs))
 		} else if ep.Method == parser.GET {
-			params = append(params, fmt.Sprintf(`// @Param %s query %s %v "%s"%s`+"\n", k, t, !v.Optional, k, attrs))
+			example, ok := structTag.Lookup("example")
+			if !ok {
+				example = k
+			}
+			params = append(params, fmt.Sprintf(`// @Param %s query %s %v "%s"%s`+"\n", k, t, !v.Optional, example, attrs))
 		}
 	}
 

samples/standard/api/get.go

@@ -17,7 +17,7 @@ const (
 
 // GetRequest ...
 type GetRequest struct {
-	Param string
+	Param string `example:"param param param"`
 	Time  time.Time
 	Enum  Enum
 }