Skip to content

Commit

Permalink
Merge pull request #350 from go-generalize/fix/swaggo-get-doc
Browse files Browse the repository at this point in the history
Fix swaggo get doc
  • Loading branch information
54m authored Nov 22, 2022
2 parents 5b5c3f1 + 289cbc5 commit faabb20
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
10 changes: 8 additions & 2 deletions pkg/server/swaggen.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand All @@ -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))
}
}

Expand Down
2 changes: 1 addition & 1 deletion samples/standard/api/get.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const (

// GetRequest ...
type GetRequest struct {
Param string
Param string `example:"param param param"`
Time time.Time
Enum Enum
}
Expand Down
2 changes: 1 addition & 1 deletion samples/standard/clients/go/classes/types.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion samples/standard/server/mock/controller/get.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit faabb20

Please sign in to comment.