add openapi schema for ipaddr, macaddr

qpalzmqaz123 · Apr 23, 2024 · 325f1d9 · 325f1d9
1 parent c756476
commit 325f1d9
Show file tree

Hide file tree

Showing 3 changed files with 93 additions and 0 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/rnest/Cargo.toml b/rnest/Cargo.toml
@@ -16,9 +16,15 @@ log = "0.4"
 actix-web = { version = "4", default-features = false }
 serde_json = { version = "1", default-features = false }
 actix-web-validator = { version = "5", default-features = false }
+eui48 = { version = "1", default-features = false, features = ["serde", "disp_hexstring"], optional = true }
 
 [dev-dependencies]
 env_logger = "0.9"
 serde = { version = "1" }
 tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
 validator = { version = "0.16", features = ["derive"] }
+
+[features]
+default = ["openapi_mac_str", "openapi_ip_str"]
+openapi_mac_str = ["eui48"]
+openapi_ip_str = []
diff --git a/rnest/src/openapi.rs b/rnest/src/openapi.rs
@@ -104,6 +104,82 @@ impl_schema_for_boolean! {AtomicBool}
 impl_schema_for_string! {&str}
 impl_schema_for_string! {String}
 
+#[cfg(feature = "openapi_ip_str")]
+impl OpenApiSchema for std::net::IpAddr {
+    fn get_schema() -> serde_json::Value {
+        serde_json::json!({
+            "type": "string",
+            "example": "127.0.0.1 | ::1",
+        })
+    }
+}
+
+#[cfg(feature = "openapi_ip_str")]
+impl OpenApiSchema for std::net::Ipv4Addr {
+    fn get_schema() -> serde_json::Value {
+        serde_json::json!({
+            "type": "string",
+            "example": "127.0.0.1",
+        })
+    }
+}
+
+#[cfg(feature = "openapi_ip_str")]
+impl OpenApiSchema for std::net::Ipv6Addr {
+    fn get_schema() -> serde_json::Value {
+        serde_json::json!({
+            "type": "string",
+            "example": "::1",
+        })
+    }
+}
+
+#[cfg(feature = "openapi_ip_str")]
+impl OpenApiSchema for std::net::SocketAddr {
+    fn get_schema() -> serde_json::Value {
+        serde_json::json!({
+            "type": "string",
+            "example": "127.0.0.1:80 or [::1]:80",
+        })
+    }
+}
+
+#[cfg(feature = "openapi_ip_str")]
+impl OpenApiSchema for std::net::SocketAddrV4 {
+    fn get_schema() -> serde_json::Value {
+        serde_json::json!({
+            "type": "string",
+            "example": "127.0.0.1:80",
+        })
+    }
+}
+
+#[cfg(feature = "openapi_ip_str")]
+impl OpenApiSchema for std::net::SocketAddrV6 {
+    fn get_schema() -> serde_json::Value {
+        serde_json::json!({
+            "type": "string",
+            "example": "[::1]:80",
+        })
+    }
+}
+
+#[cfg(feature = "openapi_mac_str")]
+impl OpenApiSchema for eui48::MacAddress {
+    fn get_schema() -> serde_json::Value {
+        serde_json::json!({
+            "type": "string",
+            "example": "01:02:03:04:05:06",
+        })
+    }
+}
+
+impl OpenApiSchema for serde_json::Value {
+    fn get_schema() -> serde_json::Value {
+        crate::json!({})
+    }
+}
+
 impl OpenApiSchema for HttpResponse {
     fn get_schema() -> serde_json::Value {
         crate::json!({})