fix: get server for Openapi specification

.config/dictionaries/project.dic

@@ -120,4 +120,7 @@ nextest
 testcov
 testdocs
 fmtchk
-fmtfix
+fmtfix
+gethostname
+afinet
+netifas

catalyst-gateway/Cargo.toml

@@ -57,6 +57,9 @@ tokio = "1"
 
 dotenvy = "0.15"
 
+local-ip-address = "0.5.7"
+gethostname = "0.4.3"
+
 [workspace.lints.rust]
 warnings = "deny"
 missing_docs = "deny"

catalyst-gateway/bin/Cargo.toml

@@ -67,4 +67,6 @@ dotenvy = { workspace = true }
 panic-message = { workspace = true }
 cpu-time = { workspace = true }
 ulid = { workspace = true, features = ["serde", "uuid"] }
-rust-embed = { workspace = true }
+rust-embed = { workspace = true }
+local-ip-address.workspace = true
+gethostname.workspace = true

catalyst-gateway/bin/src/service/api/mod.rs

@@ -2,7 +2,11 @@
 //!
 //! This defines all endpoints for the Catalyst Gateway API.
 //! It however does NOT contain any processing for them, that is defined elsewhere.
+use std::net::IpAddr;
+
+use gethostname::gethostname;
 use health::HealthApi;
+use local_ip_address::list_afinet_netifas;
 use poem_openapi::{ContactObject, LicenseObject, OpenApiService, ServerObject};
 use registration::RegistrationApi;
 use test_endpoints::TestApi;
@@ -23,6 +27,9 @@ const API_TITLE: &str = "Catalyst Gateway";
 /// The version of the API
 const API_VERSION: &str = "1.2.0";
 
+/// Port
+const PORT: &str = "5432";
+
 /// Get the contact details for inquiring about the API
 fn get_api_contact() -> ContactObject {
     ContactObject::new()
@@ -72,8 +79,34 @@ pub(crate) fn mk_api(
 
     // Add all the hosts where this API should be reachable.
     for host in hosts {
-        service = service.server(ServerObject::new(host));
+        service = service.server(ServerObject::new(host).description("API Host"));
     }
 
+    // Get localhost name
+    if let Ok(hostname) = gethostname().into_string() {
+        let hostname_with_port = format!("{hostname}:{PORT}");
+        service = service
+            .server(ServerObject::new(hostname_with_port).description("Server at localhost name"));
+    }
+
+    // Get local IP address v4 and v6
+    let network_interfaces = list_afinet_netifas();
+    if let Ok(network_interfaces) = network_interfaces {
+        for (name, ip) in &network_interfaces {
+            if *name == "en0" {
+                let (ip_with_port, desc) = match ip {
+                    IpAddr::V4(_) => {
+                        let ip_str = format!("{ip}:{PORT}");
+                        (ip_str, "Server at local IPv4 address")
+                    },
+                    IpAddr::V6(_) => {
+                        let ip_str = format!("[{ip}]:{PORT}");
+                        (ip_str, "Server at local IPv6 address")
+                    },
+                };
+                service = service.server(ServerObject::new(ip_with_port).description(desc));
+            }
+        }
+    }
     service
 }