Skip to content

feat: Add Jan API server Swagger UI #6502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 19, 2025
Merged

feat: Add Jan API server Swagger UI #6502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c802c14
feat: Add Jan API server Swagger UI
qnixsynapse Sep 17, 2025
13028c9
feat: serve Swagger UI at root path
qnixsynapse Sep 18, 2025
2e1d0a1
feat: add model loading state and translations for local API server
qnixsynapse Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 84 additions & 1 deletion src-tauri/src/core/server/proxy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,14 @@ async fn proxy_request(
let path = get_destination_path(original_path, &config.prefix);
let method = parts.method.clone();

let whitelisted_paths = ["/", "/openapi.json", "/favicon.ico"];
let whitelisted_paths = [
"/",
"/openapi.json",
"/favicon.ico",
"/docs/swagger-ui.css",
"/docs/swagger-ui-bundle.js",
"/docs/swagger-ui-standalone-preset.js",
];
let is_whitelisted_path = whitelisted_paths.contains(&path.as_str());

if !is_whitelisted_path {
Expand Down Expand Up @@ -448,6 +455,82 @@ async fn proxy_request(

return Ok(response_builder.body(Body::from(body_str)).unwrap());
}

(hyper::Method::GET, "/openapi.json") => {
let body = include_str!("../../../static/openapi.json"); // relative to src-tauri/src/
return Ok(Response::builder()
.status(StatusCode::OK)
.header(hyper::header::CONTENT_TYPE, "application/json")
.body(Body::from(body))
.unwrap());
}

// DOCS route
(hyper::Method::GET, "/") => {
let html = r#"
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>API Docs</title>
<link rel="stylesheet" type="text/css" href="/docs/swagger-ui.css">
</head>
<body>
<div id="swagger-ui"></div>
<script src="/docs/swagger-ui-bundle.js"></script>
<script>
window.onload = () => {
SwaggerUIBundle({
url: '/openapi.json',
dom_id: '#swagger-ui',
});
};
</script>
</body>
</html>
"#;

let mut response_builder = Response::builder()
.status(StatusCode::OK)
.header(hyper::header::CONTENT_TYPE, "text/html");

response_builder = add_cors_headers_with_host_and_origin(
response_builder,
&host_header,
&origin_header,
&config.trusted_hosts,
);

return Ok(response_builder.body(Body::from(html)).unwrap());
}

(hyper::Method::GET, "/docs/swagger-ui.css") => {
let css = include_str!("../../../static/swagger-ui/swagger-ui.css");
return Ok(Response::builder()
.status(StatusCode::OK)
.header(hyper::header::CONTENT_TYPE, "text/css")
.body(Body::from(css))
.unwrap());
}

(hyper::Method::GET, "/docs/swagger-ui-bundle.js") => {
let js = include_str!("../../../static/swagger-ui/swagger-ui-bundle.js");
return Ok(Response::builder()
.status(StatusCode::OK)
.header(hyper::header::CONTENT_TYPE, "application/javascript")
.body(Body::from(js))
.unwrap());
}

(hyper::Method::GET, "/favicon.ico") => {
let icon = include_bytes!("../../../static/swagger-ui/favicon.ico");
return Ok(Response::builder()
.status(StatusCode::OK)
.header(hyper::header::CONTENT_TYPE, "image/x-icon")
.body(Body::from(icon.as_ref()))
.unwrap());
}

_ => {
let is_explicitly_whitelisted_get = method == hyper::Method::GET
&& whitelisted_paths.contains(&destination_path.as_str());
Expand Down
Loading
Loading