Support examples for binary and byte formats

swagger-api · Apr 19, 2024 · 8e20f11 · 8e20f11
1 parent 502affe
commit 8e20f11
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 1 deletion.
diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/model/Item.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/model/Item.java
@@ -5,8 +5,9 @@
 public class Item {
     private String name;
     private String value;
+    @Schema(example = "Ynl0ZQ==")
     private byte[] bytes;
-    @Schema(format = "binary")
+    @Schema(format = "binary", example = "YmluYXJ5")
     private byte[] binary;
 
     public Item() {

diff --git a/modules/swagger-jaxrs2/src/test/resources/BinaryParameterResource.yaml b/modules/swagger-jaxrs2/src/test/resources/BinaryParameterResource.yaml
@@ -32,7 +32,9 @@ components:
         bytes:
           type: string
           format: byte
+          example: Ynl0ZQ==
         binary:
           type: string
           format: binary
+          example: YmluYXJ5
 
diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/BinarySchema.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/BinarySchema.java
@@ -1,5 +1,6 @@
 package io.swagger.v3.oas.models.media;
 
+import java.util.Base64;
 import java.util.List;
 import java.util.Objects;
 
@@ -39,6 +40,9 @@ protected byte[] cast(Object value) {
                 } else {
                     return value.toString().getBytes();
                 }
+                if (value instanceof String) {
+                    return Base64.getDecoder().decode((String) value);
+                }
             } catch (Exception e) {
             }
         }

diff --git a/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/ByteArraySchema.java b/modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/ByteArraySchema.java
@@ -1,5 +1,6 @@
 package io.swagger.v3.oas.models.media;
 
+import java.util.Base64;
 import java.util.List;
 import java.util.Objects;
 
@@ -39,6 +40,9 @@ protected byte[] cast(Object value) {
                 } else {
                     return value.toString().getBytes();
                 }
+                if (value instanceof String) {
+                    return Base64.getDecoder().decode((String) value);
+                }
             } catch (Exception e) {
             }
         }