doc(readme): additional Example for swaggertype (#498)

swaggo · Aug 21, 2019 · e97b3a0 · e97b3a0
1 parent 33a7940
commit e97b3a0
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -567,6 +567,33 @@ type Account struct {
 }
 ```
 
+[#379](https://github.com/swaggo/swag/issues/379)
+```go
+type CerticateKeyPair struct {
+	Crt []byte `json:"crt" swaggertype:"string" format:"base64" example:"U3dhZ2dlciByb2Nrcw=="`
+	Key []byte `json:"key" swaggertype:"string" format:"base64" example:"U3dhZ2dlciByb2Nrcw=="`
+}
+```
+generated swagger doc as follows:
+```go
+"api.MyBinding": {
+  "type":"object",
+  "properties":{
+    "crt":{
+      "type":"string",
+      "format":"base64",
+      "example":"U3dhZ2dlciByb2Nrcw=="
+    },
+    "key":{
+      "type":"string",
+      "format":"base64",
+      "example":"U3dhZ2dlciByb2Nrcw=="
+    }
+  }
+}
+
+```
+
 ### Add extension info to struct field
 
 ```go