fix: swagger ignore "-" param. #1789
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gqcn
requested changes
Apr 28, 2022
protocol/goai/goai_parameter_ref.go
Outdated
| @@ -37,6 +37,9 @@ func (oai *OpenApiV3) newParameterRefWithStructMethod(field gstructs.Field, path | |||
| parameter.Name = field.Name() | |||
| } | |||
| if len(tagMap) > 0 { | |||
| if v, ok := tagMap["json"]; ok && v == "-" { | |||
| return nil, nil | |||
| } | |||
| if err := oai.tagMapToParameter(tagMap, parameter); err != nil { | |||
| return nil, err | |||
| } | |||
There was a problem hiding this comment.
在函数末尾检查parameter.Name而不是 json 标签会更好一些，因为后期可能存在xml标签的支持。
此外，由于有多个地方需要过滤参数名称，建议封装一个函数来做过滤，例如：
func isValidParameterName(name string) bool
protocol/goai/goai_shema.go
Outdated
| @@ -169,6 +169,9 @@ func (oai *OpenApiV3) structToSchema(object interface{}) (*Schema, error) { | |||
| } | |||
| var fieldName = structField.Name() | |||
| if jsonName := structField.TagJsonName(); jsonName != "" { | |||
| if jsonName == "-" { | |||
| continue | |||
| } | |||
| fieldName = jsonName | |||
| } | |||
| schemaRef, err := oai.newSchemaRefWithGolangType( | |||
There was a problem hiding this comment.
在函数末尾统一循环过滤schema.Properties会比在循环中做过滤更好一些。
Codecov Report
@@ Coverage Diff @@
## master #1789 +/- ##
==========================================
+ Coverage 71.24% 71.27% +0.03%
==========================================
Files 457 457
Lines 43475 43493 +18
==========================================
+ Hits 30974 31001 +27
+ Misses 10516 10507 -9
Partials 1985 1985
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1765