support boolean false value in extension (#927)

swaggo · Aug 17, 2021 · 485f917 · 485f917
1 parent fd74bcf
commit 485f917
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -686,7 +686,7 @@ type Account struct {
 
 ```go
 type Account struct {
-    ID   string    `json:"id"   extensions:"x-nullable,x-abc=def"` // extensions fields must start with "x-"
+    ID   string    `json:"id"   extensions:"x-nullable,x-abc=def,!x-omitempty"` // extensions fields must start with "x-"
 }
 ```
 
@@ -699,7 +699,8 @@ generate swagger doc as follows:
         "id": {
             "type": "string",
             "x-nullable": true,
-            "x-abc": "def"
+            "x-abc": "def",
+            "x-omitempty": false
         }
     }
 }

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -656,7 +656,7 @@ type Account struct {
 
 ```go
 type Account struct {
-    ID   string    `json:"id"   extensions:"x-nullable,x-abc=def"` // 扩展字段必须以"x-"开头
+    ID   string    `json:"id"   extensions:"x-nullable,x-abc=def,!x-omitempty"` // 扩展字段必须以"x-"开头
 }
 ```
 
@@ -669,7 +669,8 @@ type Account struct {
         "id": {
             "type": "string",
             "x-nullable": true,
-            "x-abc": "def"
+            "x-abc": "def",
+            "x-omitempty": false
         }
     }
 }

diff --git a/parser.go b/parser.go
@@ -1190,7 +1190,11 @@ func (parser *Parser) parseFieldTag(field *ast.Field, types []string) (*structFi
 			if len(parts) == 2 {
 				structField.extensions[parts[0]] = parts[1]
 			} else {
-				structField.extensions[parts[0]] = true
+				if len(parts[0]) > 0 && string(parts[0][0]) == "!" {
+					structField.extensions[string(parts[0][1:])] = false
+				} else {
+					structField.extensions[parts[0]] = true
+				}
 			}
 		}
 	}

diff --git a/testdata/simple/expected.json b/testdata/simple/expected.json
@@ -600,7 +600,8 @@
         "middlename": {
           "type": "string",
           "x-abc": "def",
-          "x-nullable": true
+          "x-nullable": true,
+          "x-omitempty": false
         }
       }
     },

diff --git a/testdata/simple/web/handler.go b/testdata/simple/web/handler.go
@@ -53,7 +53,7 @@ type CrossAlias cross.Cross
 
 type Pet2 struct {
 	ID         int        `json:"id"`
-	MiddleName *string    `json:"middlename" extensions:"x-nullable,x-abc=def"`
+	MiddleName *string    `json:"middlename" extensions:"x-nullable,x-abc=def,!x-omitempty"`
 	DeletedAt  *time.Time `json:"deleted_at"`
 }