Add support for more generic types

Add support for generic types which are serializable via serde * Add support for Box * Add support for RefCell
juhaku · Jan 28, 2022 · a711146 · a711146
1 parent d5e8cc5
commit a711146
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 2 deletions.
diff --git a/tests/component_derive_test.rs b/tests/component_derive_test.rs
@@ -1,4 +1,4 @@
-use std::{borrow::Cow, collections::HashMap, vec};
+use std::{borrow::Cow, cell::RefCell, collections::HashMap, vec};
 
 use serde_json::Value;
 use utoipa::{Component, OpenApi};
@@ -468,3 +468,26 @@ fn derive_struct_with_cow() {
         "required.[0]" = r###""greeting""###, "Greeting required"
     };
 }
+
+#[test]
+fn derive_with_box_and_refcell() {
+    #[allow(unused)]
+    struct Foo {
+        name: &'static str,
+    }
+
+    let greeting = api_doc! {
+        struct Greeting {
+            foo: Box<Foo>,
+            ref_cell_foo: RefCell<Foo>
+        }
+    };
+
+    common::assert_json_array_len(greeting.get("required").unwrap(), 2);
+    assert_value! {greeting=>
+        "properties.foo.$ref" = r###""#/components/schemas/Foo""###, "Greeting foo field"
+        "properties.ref_cell_foo.$ref" = r###""#/components/schemas/Foo""###, "Greeting ref_cell_foo field"
+        "required.[0]" = r###""foo""###, "Greeting required 0"
+        "required.[1]" = r###""ref_cell_foo""###, "Greeting required 1"
+    };
+}
diff --git a/utoipa-gen/src/component.rs b/utoipa-gen/src/component.rs
@@ -385,6 +385,8 @@ impl<'a> ComponentPart<'a> {
             "Vec" => Some(GenericType::Vec),
             "Option" => Some(GenericType::Option),
             "Cow" => Some(GenericType::Cow),
+            "Box" => Some(GenericType::Box),
+            "RefCell" => Some(GenericType::RefCell),
             _ => None,
         }
     }
@@ -404,6 +406,8 @@ enum GenericType {
     Map,
     Option,
     Cow,
+    Box,
+    RefCell,
 }
 
 #[cfg_attr(feature = "debug", derive(Debug))]
@@ -469,7 +473,10 @@ where
                     #component_property.to_array()
                 });
             }
-            Some(GenericType::Option) | Some(GenericType::Cow) => {
+            Some(GenericType::Option)
+            | Some(GenericType::Cow)
+            | Some(GenericType::Box)
+            | Some(GenericType::RefCell) => {
                 let component_property = ComponentProperty::new(
                     self.component_part.child.as_ref().unwrap(),
                     self.comments,