Add support for time crate

Add support for time crate for `Component`s and `IntoParams` parameters. This add support for `OffsetDateTime`, `Date`, `PrimitiveDateTime` and `Duration` types and they are resolved as `String` by default. `OffsetDateTime` and `PrimitiveDateTime` uses `date-time` format and `Date` uses `date` format. `Duration` does not have default format. Users wishing to use alternative representations for above `time` crate types they need to override type with `#[component(value_type = ...)]` property.
juhaku · Jul 24, 2022 · 8e2b35d · 8e2b35d
1 parent eeb0dd4
commit 8e2b35d
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 3 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -31,6 +31,7 @@ chrono_with_format = ["utoipa-gen/chrono_with_format"]
 decimal = ["utoipa-gen/decimal"]
 yaml = ["serde_yaml"]
 uuid = ["utoipa-gen/uuid"]
+time = ["utoipa-gen/time"]
 
 [dependencies]
 serde = { version = "1.0", features = ["derive"] }
@@ -47,6 +48,7 @@ chrono = { version  = "0.4", features = ["serde"] }
 rust_decimal = "1"
 rocket = "0.5.0-rc.1"
 uuid = "1"
+time = { version = "0.3.11", features = [ "serde-human-readable" ] }
 
 [workspace]
 members = [

diff --git a/tests/component_derive_test.rs b/tests/component_derive_test.rs
@@ -1244,6 +1244,51 @@ fn derive_component_with_chrono_with_chrono_feature() {
     }
 }
 
+#[cfg(feature = "time")]
+#[test]
+fn derive_component_with_chrono_with_chrono_feature() {
+    use time::{Date, Duration, OffsetDateTime, PrimitiveDateTime};
+
+    let times = api_doc! {
+        struct Timetest {
+            datetime: OffsetDateTime,
+            primitive_date_time: PrimitiveDateTime,
+            date: Date,
+            duration: Duration,
+        }
+    };
+
+    assert_json_eq!(
+        &times,
+        json!({
+            "properties": {
+                "date": {
+                    "format": "date",
+                    "type": "string"
+                },
+                "datetime": {
+                    "format": "date-time",
+                    "type": "string"
+                },
+                "primitive_date_time": {
+                    "format": "date-time",
+                    "type": "string"
+                },
+                "duration": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "datetime",
+                "primitive_date_time",
+                "date",
+                "duration"
+            ],
+            "type": "object"
+        })
+    )
+}
+
 #[test]
 fn derive_struct_component_field_type_override() {
     let post = api_doc! {

diff --git a/utoipa-gen/Cargo.toml b/utoipa-gen/Cargo.toml
@@ -40,3 +40,4 @@ decimal = []
 rocket_extras = ["regex", "lazy_static"]
 uuid = ["dep:uuid"]
 axum_extras = []
+time = []
diff --git a/utoipa-gen/src/component_type.rs b/utoipa-gen/src/component_type.rs
@@ -20,7 +20,8 @@ impl ComponentType<'_> {
             feature = "chrono_with_format",
             feature = "decimal",
             feature = "rocket_extras",
-            feature = "uuid"
+            feature = "uuid",
+            feature = "time",
         )))]
         {
             is_primitive(name)
@@ -32,6 +33,7 @@ impl ComponentType<'_> {
             feature = "decimal",
             feature = "rocket_extras",
             feature = "uuid",
+            feature = "time",
         ))]
         {
             let mut primitive = is_primitive(name);
@@ -56,6 +58,14 @@ impl ComponentType<'_> {
                 primitive = matches!(name, "Uuid");
             }
 
+            #[cfg(feature = "time")]
+            if !primitive {
+                primitive = matches!(
+                    name,
+                    "Date" | "PrimitiveDateTime" | "OffsetDateTime" | "Duration"
+                );
+            }
+
             primitive
         }
     }
@@ -123,6 +133,12 @@ impl ToTokens for ComponentType<'_> {
             "PathBuf" => tokens.extend(quote! { utoipa::openapi::ComponentType::String }),
             #[cfg(feature = "uuid")]
             "Uuid" => tokens.extend(quote! { utoipa::openapi::ComponentType::String }),
+            #[cfg(feature = "time")]
+            "Date" | "PrimitiveDateTime" | "OffsetDateTime" => {
+                tokens.extend(quote! { utoipa::openapi::ComponentType::String })
+            }
+            #[cfg(feature = "time")]
+            "Duration" => tokens.extend(quote! { utoipa::openapi::ComponentType::String }),
             _ => tokens.extend(quote! { utoipa::openapi::ComponentType::Object }),
         }
     }
@@ -180,12 +196,12 @@ impl Type<'_> {
         };
         let name = &*last_segment.ident.to_string();
 
-        #[cfg(not(any(feature = "chrono_with_format", feature = "uuid")))]
+        #[cfg(not(any(feature = "chrono_with_format", feature = "uuid", feature = "time")))]
         {
             is_known_format(name)
         }
 
-        #[cfg(any(feature = "chrono_with_format", feature = "uuid"))]
+        #[cfg(any(feature = "chrono_with_format", feature = "uuid", feature = "time"))]
         {
             let mut known_format = is_known_format(name);
 
@@ -199,6 +215,11 @@ impl Type<'_> {
                 known_format = matches!(name, "Uuid");
             }
 
+            #[cfg(feature = "time")]
+            if !known_format {
+                known_format = matches!(name, "Date" | "PrimitiveDateTime" | "OffsetDateTime");
+            }
+
             known_format
         }
     }
@@ -231,6 +252,12 @@ impl ToTokens for Type<'_> {
             "Date" => tokens.extend(quote! { utoipa::openapi::ComponentFormat::Date }),
             #[cfg(feature = "uuid")]
             "Uuid" => tokens.extend(quote! { utoipa::openapi::ComponentFormat::Uuid }),
+            #[cfg(feature = "time")]
+            "Date" => tokens.extend(quote! { utoipa::openapi::ComponentFormat::Date }),
+            #[cfg(feature = "time")]
+            "PrimitiveDateTime" | "OffsetDateTime" => {
+                tokens.extend(quote! { utoipa::openapi::ComponentFormat::DateTime })
+            }
             _ => (),
         }
     }