package spec import ( "errors" "strings" "github.com/tal-tech/go-zero/core/stringx" "github.com/tal-tech/go-zero/tools/goctl/util" ) const ( bodyTagKey = "json" formTagKey = "form" defaultSummaryKey = "summary" ) var definedKeys = []string{bodyTagKey, formTagKey, "path"} // Routes returns all routes in api service func (s Service) Routes() []Route { var result []Route for _, group := range s.Groups { result = append(result, group.Routes...) } return result } // Tags retuens all tags in Member func (m Member) Tags() []*Tag { tags, err := Parse(m.Tag) if err != nil { panic(m.Tag + ", " + err.Error()) } return tags.Tags() } // IsOptional returns true if tag is optional func (m Member) IsOptional() bool { if !m.IsBodyMember() { return false } tag := m.Tags() for _, item := range tag { if item.Key == bodyTagKey { if stringx.Contains(item.Options, "optional") { return true } } } return false } // IsOmitEmpty returns true if tag contains omitempty func (m Member) IsOmitEmpty() bool { if !m.IsBodyMember() { return false } tag := m.Tags() for _, item := range tag { if item.Key == bodyTagKey { if stringx.Contains(item.Options, "omitempty") { return true } } } return false } // GetPropertyName returns json tag value func (m Member) GetPropertyName() (string, error) { tags := m.Tags() for _, tag := range tags { if stringx.Contains(definedKeys, tag.Key) { if tag.Name == "-" { return util.Untitle(m.Name), nil } return tag.Name, nil } } return "", errors.New("json property name not exist, member: " + m.Name) } // GetComment returns comment value of Member func (m Member) GetComment() string { return strings.TrimSpace(m.Comment) } // IsBodyMember returns true if contains json tag func (m Member) IsBodyMember() bool { if m.IsInline { return true } tags := m.Tags() for _, tag := range tags { if tag.Key == bodyTagKey { return true } } return false } // IsFormMember returns true if contains form tag func (m Member) IsFormMember() bool { if m.IsInline { return false } tags := m.Tags() for _, tag := range tags { if tag.Key == formTagKey { return true } } return false } // GetBodyMembers returns all json fields func (t DefineStruct) GetBodyMembers() []Member { var result []Member for _, member := range t.Members { if member.IsBodyMember() { result = append(result, member) } } return result } // GetFormMembers returns all form fields func (t DefineStruct) GetFormMembers() []Member { var result []Member for _, member := range t.Members { if member.IsFormMember() { result = append(result, member) } } return result } // GetNonBodyMembers retruns all have no tag fields func (t DefineStruct) GetNonBodyMembers() []Member { var result []Member for _, member := range t.Members { if !member.IsBodyMember() { result = append(result, member) } } return result } // JoinedDoc joins comments and summary value in AtDoc func (r Route) JoinedDoc() string { doc := r.AtDoc.Text if r.AtDoc.Properties != nil { doc += r.AtDoc.Properties[defaultSummaryKey] } doc += strings.Join(r.Docs, " ") return strings.TrimSpace(doc) } // GetAnnotation returns the value by specified key func (r Route) GetAnnotation(key string) string { if r.Annotation.Properties == nil { return "" } return r.Annotation.Properties[key] } // GetAnnotation returns the value by specified key func (g Group) GetAnnotation(key string) string { if g.Annotation.Properties == nil { return "" } return g.Annotation.Properties[key] } // ResponseTypeName returns response type name of route func (r Route) ResponseTypeName() string { if r.ResponseType == nil { return "" } return r.ResponseType.Name() } // RequestTypeName returns request type name of route func (r Route) RequestTypeName() string { if r.RequestType == nil { return "" } return r.RequestType.Name() }