feat: struct fields allow empty example strings (#1125)

swaggo · Feb 3, 2022 · e1ac437 · e1ac437
1 parent 808bde6
commit e1ac437
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/field_parser.go b/field_parser.go
@@ -182,8 +182,8 @@ func (ps *tagBaseFieldParser) ComplementSchema(schema *spec.Schema) error {
 	jsonTag := ps.tag.Get(jsonTag)
 	// json:"name,string" or json:",string"
 
-	exampleTag := ps.tag.Get(exampleTag)
-	if exampleTag != "" {
+	exampleTag, ok := ps.tag.Lookup(exampleTag)
+	if ok {
 		structField.exampleValue = exampleTag
 		if !strings.Contains(jsonTag, ",string") {
 			example, err := defineTypeOfExample(structField.schemaType, structField.arrayType, exampleTag)

diff --git a/field_parser_test.go b/field_parser_test.go
@@ -23,6 +23,17 @@ func TestDefaultFieldParser(t *testing.T) {
 		assert.NoError(t, err)
 		assert.Equal(t, "one", schema.Example)
 
+		schema = spec.Schema{}
+		schema.Type = []string{"string"}
+		err = newTagBaseFieldParser(
+			&Parser{},
+			&ast.Field{Tag: &ast.BasicLit{
+				Value: `json:"test" example:""`,
+			}},
+		).ComplementSchema(&schema)
+		assert.NoError(t, err)
+		assert.Equal(t, "", schema.Example)
+
 		schema = spec.Schema{}
 		schema.Type = []string{"float"}
 		err = newTagBaseFieldParser(