Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions generate/parser.go
Original file line number Diff line number Diff line change
Expand Up @@ -412,22 +412,23 @@ func renderStruct(member spec.Member) swaggerParameterObject {
}

func renderReplyAsDefinition(d swaggerDefinitionsObject, m messageMap, p []spec.Type, refs refMap) {
var members = make(map[string]string)
for _, i2 := range p {
schema := swaggerSchemaObject{
schemaCore: schemaCore{
Type: "object",
},
}
defineStruct, _ := i2.(spec.DefineStruct)

schema.Title = defineStruct.Name()

for _, member := range defineStruct.Members {
if hasPathParameters(member) || hasHeaderParameters(member) {
continue
}
kv := keyVal{Value: schemaOfField(member)}
value := schemaOfField(member)
kv := keyVal{Value: value}
kv.Key = member.Name
members[kv.Key] = value.Description
if tag, err := member.GetPropertyName(); err == nil {
kv.Key = tag
}
Expand Down Expand Up @@ -484,9 +485,18 @@ func renderReplyAsDefinition(d swaggerDefinitionsObject, m messageMap, p []spec.
}
}
}

if k, ok := members[schema.Title]; ok {
schema.Description = k
}
d[i2.Name()] = schema
}

for name, schema := range d {
if des, ok := members[name]; ok {
schema.Description = des
d[name] = schema
}
}
}

func hasPathParameters(member spec.Member) bool {
Expand All @@ -512,10 +522,8 @@ func schemaOfField(member spec.Member) swaggerSchemaObject {
ret := swaggerSchemaObject{}

var core schemaCore

kind := swaggerMapTypes[member.Type.Name()]
var props *swaggerSchemaObjectProperties

comment := member.GetComment()
comment = strings.Replace(comment, "//", "", -1)

Expand Down Expand Up @@ -544,7 +552,6 @@ func schemaOfField(member spec.Member) swaggerSchemaObject {
} else {
core.Items = &swaggerItemsObject{Type: ft.String(), Format: "UNKNOWN"}
}

} else {
core = schemaCore{
Ref: "#/definitions/" + refTypeName,
Expand All @@ -567,7 +574,6 @@ func schemaOfField(member spec.Member) swaggerSchemaObject {
core = schemaCore{Type: ft.String(), Format: "UNKNOWN"}
}
}

switch ft := kind; ft {
case reflect.Slice:
ret = swaggerSchemaObject{
Expand Down Expand Up @@ -601,7 +607,6 @@ func schemaOfField(member spec.Member) swaggerSchemaObject {
}
}
ret.Description = comment

for _, tag := range member.Tags() {
if len(tag.Options) == 0 {
continue
Expand Down Expand Up @@ -635,7 +640,6 @@ func schemaOfField(member spec.Member) swaggerSchemaObject {
}
}
}

return ret
}

Expand Down
61 changes: 60 additions & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
module github.com/zeromicro/goctl-swagger

go 1.16
go 1.21

toolchain go1.22.6

require (
github.com/grpc-ecosystem/grpc-gateway v1.16.0
Expand All @@ -9,3 +11,60 @@ require (
github.com/zeromicro/go-zero/tools/goctl v1.6.5
golang.org/x/oauth2 v0.17.0
)

require (
github.com/beorn7/perks v1.0.1 // indirect
github.com/cenkalti/backoff/v4 v4.2.1 // indirect
github.com/cespare/xxhash/v2 v2.2.0 // indirect
github.com/cpuguy83/go-md2man/v2 v2.0.3 // indirect
github.com/fatih/color v1.16.0 // indirect
github.com/fatih/structtag v1.2.0 // indirect
github.com/ghodss/yaml v1.0.0 // indirect
github.com/go-logr/logr v1.3.0 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/golang-jwt/jwt/v4 v4.5.0 // indirect
github.com/golang/glog v1.2.0 // indirect
github.com/golang/protobuf v1.5.4 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/gookit/color v1.5.4 // indirect
github.com/grpc-ecosystem/grpc-gateway/v2 v2.18.0 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0 // indirect
github.com/openzipkin/zipkin-go v0.4.2 // indirect
github.com/pelletier/go-toml/v2 v2.2.2 // indirect
github.com/prometheus/client_golang v1.18.0 // indirect
github.com/prometheus/client_model v0.5.0 // indirect
github.com/prometheus/common v0.45.0 // indirect
github.com/prometheus/procfs v0.12.0 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/spaolacci/murmur3 v1.1.0 // indirect
github.com/spf13/cobra v1.8.0 // indirect
github.com/spf13/pflag v1.0.5 // indirect
github.com/xo/terminfo v0.0.0-20210125001918-ca9a967f8778 // indirect
github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
github.com/zeromicro/antlr v0.0.1 // indirect
go.opentelemetry.io/otel v1.19.0 // indirect
go.opentelemetry.io/otel/exporters/jaeger v1.17.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.19.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.19.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.19.0 // indirect
go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.19.0 // indirect
go.opentelemetry.io/otel/exporters/zipkin v1.19.0 // indirect
go.opentelemetry.io/otel/metric v1.19.0 // indirect
go.opentelemetry.io/otel/sdk v1.19.0 // indirect
go.opentelemetry.io/otel/trace v1.19.0 // indirect
go.opentelemetry.io/proto/otlp v1.0.0 // indirect
go.uber.org/automaxprocs v1.5.3 // indirect
golang.org/x/net v0.25.0 // indirect
golang.org/x/sys v0.20.0 // indirect
golang.org/x/text v0.15.0 // indirect
google.golang.org/appengine v1.6.8 // indirect
google.golang.org/genproto v0.0.0-20240227224415-6ceb2ff114de // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20240227224415-6ceb2ff114de // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20240227224415-6ceb2ff114de // indirect
google.golang.org/grpc v1.63.2 // indirect
google.golang.org/protobuf v1.34.1 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
)
Loading