transform struct fields of array enum type in a struct to query/formD…

…ata params (#1523) Signed-off-by: sdghchj <[email protected]>
swaggo · Apr 4, 2023 · e67c965 · e67c965
1 parent 314d61f
commit e67c965
Show file tree

Hide file tree

Showing 4 changed files with 103 additions and 7 deletions.
diff --git a/operation.go b/operation.go
@@ -321,16 +321,26 @@ func (operation *Operation) ParseParamComment(commentLine string, astFile *ast.F
 				}
 
 				switch {
-				case prop.Type[0] == ARRAY && prop.Items.Schema != nil &&
-					len(prop.Items.Schema.Type) > 0 && IsSimplePrimitiveType(prop.Items.Schema.Type[0]):
-
-					param = createParameter(paramType, prop.Description, formName, prop.Type[0], prop.Items.Schema.Type[0], findInSlice(schema.Required, name), enums, operation.parser.collectionFormatInQuery)
+				case prop.Type[0] == ARRAY:
+					if prop.Items.Schema == nil {
+						continue
+					}
+					itemSchema := prop.Items.Schema
+					if len(itemSchema.Type) == 0 {
+						itemSchema = operation.parser.getUnderlyingSchema(prop.Items.Schema)
+					}
+					if len(itemSchema.Type) == 0 {
+						continue
+					}
+					if !IsSimplePrimitiveType(itemSchema.Type[0]) {
+						continue
+					}
+					param = createParameter(paramType, prop.Description, formName, prop.Type[0], itemSchema.Type[0], findInSlice(schema.Required, name), itemSchema.Enum, operation.parser.collectionFormatInQuery)
 
 				case IsSimplePrimitiveType(prop.Type[0]):
-					param = createParameter(paramType, prop.Description, formName, PRIMITIVE, prop.Type[0], findInSlice(schema.Required, name), enums, operation.parser.collectionFormatInQuery)
+					param = createParameter(paramType, prop.Description, formName, PRIMITIVE, prop.Type[0], findInSlice(schema.Required, name), nil, operation.parser.collectionFormatInQuery)
 				default:
 					operation.parser.debug.Printf("skip field [%s] in %s is not supported type for %s", name, refType, paramType)
-
 					continue
 				}
 

diff --git a/testdata/enums/api/api.go b/testdata/enums/api/api.go
@@ -29,9 +29,20 @@ func API2() {
 //
 //		@Summary      test enums fields in formdata request
 //		@Description  test enums fields in formdata request
-//		@Param 		  stdeunt formData types.Person true "type"
+//		@Param 		  student formData types.Person true "type"
 //		@Success      200   "ok"
 //		@Router       /students2 [get]
 func API3() {
 	_ = types.Person{}
 }
+
+//	 post students
+//
+//		@Summary      test array enums fields in formdata request
+//		@Description  test array enums fields in formdata request
+//		@Param 		  student formData types.PersonWithArrayEnum true "type"
+//		@Success      200   "ok"
+//		@Router       /students4 [get]
+func API4() {
+	_ = types.Person{}
+}
diff --git a/testdata/enums/expected.json b/testdata/enums/expected.json
@@ -168,6 +168,74 @@
                     }
                 }
             }
+        },
+        "/students4": {
+            "get": {
+                "description": "test array enums fields in formdata request",
+                "summary": "test array enums fields in formdata request",
+                "parameters": [
+                    {
+                        "type": "array",
+                        "items": {
+                            "enum": [
+                                -1,
+                                1,
+                                2,
+                                3,
+                                4,
+                                5
+                            ],
+                            "type": "integer"
+                        },
+                        "name": "class",
+                        "in": "formData"
+                    },
+                    {
+                        "type": "array",
+                        "items": {
+                            "enum": [
+                                1,
+                                2,
+                                4,
+                                8
+                            ],
+                            "type": "integer"
+                        },
+                        "name": "mask",
+                        "in": "formData"
+                    },
+                    {
+                        "type": "string",
+                        "name": "name",
+                        "in": "formData"
+                    },
+                    {
+                        "enum": [
+                            "teacher",
+                            "student",
+                            "Other"
+                        ],
+                        "type": "string",
+                        "x-enum-comments": {
+                            "Other": "Other",
+                            "Student": "student",
+                            "Teacher": "teacher"
+                        },
+                        "x-enum-varnames": [
+                            "Teacher",
+                            "Student",
+                            "Other"
+                        ],
+                        "name": "type",
+                        "in": "formData"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "ok"
+                    }
+                }
+            }
         }
     },
     "definitions": {

diff --git a/testdata/enums/types/model.go b/testdata/enums/types/model.go
@@ -55,3 +55,10 @@ type Person struct {
 	Mask  Mask
 	Type  Type
 }
+
+type PersonWithArrayEnum struct {
+	Name  string
+	Class []Class
+	Mask  []Mask
+	Type  Type
+}