Fix inconsistent content-type headers for JSON responses

Author: tembo[bot]

crates/rapid-cli/templates/nextjs/pages/api/routes/hello.rs

@@ -1,10 +1,20 @@
 use rapid_web::actix::HttpResponse;
+use rapid_web::json_response;
 use rapid_web::rapid_web_codegen::rapid_handler;
+use serde::Serialize;
 
 pub const ROUTE_KEY: &str = "hello";
-pub type RapidOutput = String;
+pub type RapidOutput = HelloResponse;
+
+#[derive(Serialize)]
+pub struct HelloResponse {
+    message: String,
+}
 
 #[rapid_handler]
 pub async fn query() -> HttpResponse {
-    HttpResponse::Ok().body("Hello from a RAPID rust endpoint!")
+    let response = HelloResponse {
+        message: String::from("Hello from a RAPID rust endpoint!"),
+    };
+    json_response(response)
 }

crates/rapid-cli/templates/remix-without-clerk/app/api/routes/hello.rs

@@ -1,10 +1,20 @@
 use rapid_web::actix::HttpResponse;
+use rapid_web::json_response;
 use rapid_web::rapid_web_codegen::rapid_handler;
+use serde::Serialize;
 
 pub const ROUTE_KEY: &str = "hello";
-pub type RapidOutput = String;
+pub type RapidOutput = HelloResponse;
+
+#[derive(Serialize)]
+pub struct HelloResponse {
+    message: String,
+}
 
 #[rapid_handler]
 pub async fn query() -> HttpResponse {
-    HttpResponse::Ok().body("Hello from a RAPID rust endpoint!")
+    let response = HelloResponse {
+        message: String::from("Hello from a RAPID rust endpoint!"),
+    };
+    json_response(response)
 }

crates/rapid-cli/templates/remix/app/api/routes/hello.rs

@@ -1,10 +1,20 @@
 use rapid_web::actix::HttpResponse;
+use rapid_web::json_response;
 use rapid_web::rapid_web_codegen::rapid_handler;
+use serde::Serialize;
 
 pub const ROUTE_KEY: &str = "hello";
-pub type RapidOutput = String;
+pub type RapidOutput = HelloResponse;
+
+#[derive(Serialize)]
+pub struct HelloResponse {
+    message: String,
+}
 
 #[rapid_handler]
 pub async fn query() -> HttpResponse {
-    HttpResponse::Ok().body("Hello from a RAPID rust endpoint!")
+    let response = HelloResponse {
+        message: String::from("Hello from a RAPID rust endpoint!"),
+    };
+    json_response(response)
 }

crates/rapid-web/src/lib.rs

@@ -4,13 +4,14 @@ pub use actix_web as actix;
 pub use actix_web_httpauth as auth;
 pub use default_routes::templates::WELCOME_TEMPLATE as welcome_view;
 pub use rapid_web_codegen;
+pub use util::json_response;
 pub(crate) mod default_routes;
 pub mod logger;
 pub mod server;
 pub mod shift; // TODO: shift needs to be abstracted out into its own crate
 pub(crate) mod tui;
 pub mod types;
-pub(crate) mod util;
+pub mod util;
 
 // Create new namings for every actix extractor (this is so that Shift can easily parse new route files and generate the correct typescript types)
 pub mod request {

crates/rapid-web/src/util.rs

@@ -6,6 +6,7 @@ use rapid_cli::rapid_config::config::{RapidConfig, ServerConfig};
 use std::{env::current_dir, fs::File, io::Read, path::PathBuf};
 use syn::{parse_file, parse_str, File as SynFile, Item};
 use walkdir::WalkDir;
+use super::actix::{web, HttpResponse};
 
 pub const REMIX_ROUTE_PATH: &'static str = "app/api/routes";
 pub const NEXTJS_ROUTE_PATH: &'static str = "pages/api/routes";
@@ -237,6 +238,31 @@ pub fn is_serving_static_files() -> bool {
 	}
 }
 
+/// Creates an HTTP response with JSON data and the correct content-type header.
+/// 
+/// This function ensures that all JSON responses consistently use the
+/// "application/json; charset=utf-8" content-type header.
+/// 
+/// # Examples
+/// 
+/// ```
+/// use rapid_web::util::json_response;
+/// 
+/// #[rapid_handler]
+/// async fn query() -> HttpResponse {
+///     let data = serde_json::json!({ "message": "Hello world!" });
+///     json_response(data)
+/// }
+/// ```
+pub fn json_response<T>(data: T) -> HttpResponse 
+where 
+    T: serde::Serialize,
+{
+    HttpResponse::Ok()
+        .content_type("application/json; charset=utf-8")
+        .json(data)
+}
+
 #[cfg(test)]
 mod tests {
 	use super::*;

examples/fullstackNextjs/pages/api/routes/hello.rs

@@ -1,10 +1,20 @@
 use rapid_web::actix::HttpResponse;
+use rapid_web::json_response;
 use rapid_web::rapid_web_codegen::rapid_handler;
+use serde::Serialize;
 
 pub const ROUTE_KEY: &str = "hello";
-pub type RapidOutput = String;
+pub type RapidOutput = HelloResponse;
+
+#[derive(Serialize)]
+pub struct HelloResponse {
+    message: String,
+}
 
 #[rapid_handler]
 pub async fn query() -> HttpResponse {
-    HttpResponse::Ok().body("Hello from a RAPID rust endpoint!")
+    let response = HelloResponse {
+        message: String::from("Hello from a RAPID rust endpoint!"),
+    };
+    json_response(response)
 }

examples/fullstackRemix/app/api/routes/hello.rs

@@ -1,10 +1,20 @@
 use rapid_web::actix::HttpResponse;
+use rapid_web::json_response;
 use rapid_web::rapid_web_codegen::rapid_handler;
+use serde::Serialize;
 
 pub const ROUTE_KEY: &str = "hello";
-pub type RapidOutput = String;
+pub type RapidOutput = HelloResponse;
+
+#[derive(Serialize)]
+pub struct HelloResponse {
+    message: String,
+}
 
 #[rapid_handler]
 pub async fn query() -> HttpResponse {
-    HttpResponse::Ok().body("Hello from a RAPID rust endpoint!")
+    let response = HelloResponse {
+        message: String::from("Hello from a RAPID rust endpoint!"),
+    };
+    json_response(response)
 }