implement pattern tag (#1553)

Co-authored-by: Tobias Theel <[email protected]>
swaggo · Apr 17, 2023 · 543e18b · 543e18b
1 parent 44b59ad
commit 543e18b
Show file tree

Hide file tree

Showing 5 changed files with 726 additions and 0 deletions.
diff --git a/field_parser.go b/field_parser.go
@@ -173,6 +173,7 @@ type structField struct {
 	enums        []interface{}
 	enumVarNames []interface{}
 	unique       bool
+	pattern      string
 }
 
 // splitNotWrapped slices s into all substrings separated by sep if sep is not
@@ -337,6 +338,11 @@ func (ps *tagBaseFieldParser) complementSchema(schema *spec.Schema, types []stri
 		if minLength != nil {
 			field.minLength = minLength
 		}
+
+		pattern, ok := ps.tag.Lookup(patternTag)
+		if ok {
+			field.pattern = pattern
+		}
 	}
 
 	// json:"name,string" or json:",string"
@@ -445,6 +451,7 @@ func (ps *tagBaseFieldParser) complementSchema(schema *spec.Schema, types []stri
 		schema.MaxItems = field.maxItems
 		schema.MinItems = field.minItems
 		schema.UniqueItems = field.unique
+		schema.Pattern = field.pattern
 
 		eleSchema = schema.Items.Schema
 		eleSchema.Format = field.formatType
@@ -456,6 +463,7 @@ func (ps *tagBaseFieldParser) complementSchema(schema *spec.Schema, types []stri
 	eleSchema.MaxLength = field.maxLength
 	eleSchema.MinLength = field.minLength
 	eleSchema.Enum = field.enums
+	eleSchema.Pattern = field.pattern
 
 	return nil
 }

diff --git a/field_parser_test.go b/field_parser_test.go
@@ -668,4 +668,48 @@ func TestValidTags(t *testing.T) {
 		assert.NoError(t, err)
 		assert.Empty(t, schema.Enum)
 	})
+
+	t.Run("Pattern tag", func(t *testing.T) {
+		t.Parallel()
+
+		schema := spec.Schema{}
+		schema.Type = []string{"array"}
+		schema.Items = &spec.SchemaOrArray{
+			Schema: &spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Type: []string{"string"},
+				},
+			},
+		}
+		err := newTagBaseFieldParser(
+			&Parser{},
+			&ast.Field{Tag: &ast.BasicLit{
+				Value: `json:"test" pattern:"^[a-zA-Z0-9_]*$"`,
+			}},
+		).ComplementSchema(&schema)
+		assert.NoError(t, err)
+		assert.Equal(t, "^[a-zA-Z0-9_]*$", schema.Pattern)
+	})
+
+	t.Run("Pattern tag array", func(t *testing.T) {
+		t.Parallel()
+
+		schema := spec.Schema{}
+		schema.Type = []string{"array"}
+		schema.Items = &spec.SchemaOrArray{
+			Schema: &spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Type: []string{"string"},
+				},
+			},
+		}
+		err := newTagBaseFieldParser(
+			&Parser{},
+			&ast.Field{Tag: &ast.BasicLit{
+				Value: `json:"test" pattern:"^[a-zA-Z0-9_]*$"`,
+			}},
+		).ComplementSchema(&schema)
+		assert.NoError(t, err)
+		assert.Equal(t, "^[a-zA-Z0-9_]*$", schema.Items.Schema.Pattern)
+	})
 }