Skip to content

feat(openapi-metadata): Update Scalar UI integration and add Scalar UI configuration options #2419

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(openapi-metadata): Update Scalar UI integration and add Scalar UI configuration options #2419

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
561de64
feat(openapi-metadata): Update Scalar UI integration and add Scalar U…
Ackuq Aug 17, 2025
fb57390
Add changeset
Ackuq Aug 17, 2025
8ba731d
Format
Ackuq Aug 17, 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
5 changes: 5 additions & 0 deletions .changeset/short-bears-sneeze.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"openapi-metadata": patch
---

Add configuration options for Scalar UI generation
4 changes: 2 additions & 2 deletions docs/openapi-metadata/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ app.get("/api", async (req, res) => {
});

app.get("/api/docs", (req, res) => {
const ui = generateScalarUI("/api");
const ui = generateScalarUI("/api", { theme: "purple" });
res.send(ui);
});
```
Expand All @@ -45,7 +45,7 @@ app.get("/api", async () => {
});

app.get("/api/docs", () => {
const ui = generateScalarUI("/api");
const ui = generateScalarUI("/api", { theme: "purple" });
return ui;
});
```
2 changes: 1 addition & 1 deletion docs/openapi-metadata/ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ title: UI integrations
```ts twoslash
import { generateScalarUI } from "openapi-metadata/ui";

generateScalarUI("http://localhost:3000/api");
generateScalarUI("http://localhost:3000/api", { theme: "purple" });
```

## [Swagger UI](https://swagger.io/tools/swagger-ui/)
Expand Down
69 changes: 64 additions & 5 deletions packages/openapi-metadata/src/ui/scalar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,64 @@
/**
* Options for generating the Scalar UI.
*
* See: https://guides.scalar.com/scalar/scalar-api-references/configuration
*/
export type GenerateScalarUIOptions = {
url?: string;
content?: string | object | (() => object) | null;
title?: string;
slug?: string;
baseServerURL?: string;
hideClientButton?: boolean;
proxyUrl?: string;
searchHotKey?: string;
servers?: any[];
showSidebar?: boolean;
theme?:
| "alternate"
| "default"
| "moon"
| "purple"
| "solarized"
| "bluePlanet"
| "deepSpace"
| "saturn"
| "kepler"
| "elysiajs"
| "fastify"
| "mars"
| "laserwave"
| "none";
persistAuth?: boolean;
plugins?: any[];
layout?: "modern" | "classic";
isLoading?: boolean;
hideModels?: boolean;
documentDownloadType?: "yaml" | "json" | "both" | "none";
hideDownloadButton?: boolean;
hideTestRequestButton?: boolean;
hideSearch?: boolean;
darkMode?: boolean;
forceDarkModeState?: "dark" | "light";
hideDarkModeToggle?: boolean;
metaData?: any;
favicon?: string;
hiddenClients?: Record<string, boolean | string[]> | string[] | true;
defaultHttpClient?: { targetKey: string; clientKey: string };
customCss?: string;
pathRouting?: { basePath: string };
withDefaultFonts?: boolean;
defaultOpenAllTags?: boolean;
tagsSorter?: "alpha" | ((a: any, b: any) => number);
operationsSorter?: "alpha" | "method" | ((a: any, b: any) => number);
};

/**
* Generates HTML to display Scalar UI.
*
* @see https://scalar.com/
*/
export function generateScalarUI(url: string) {
export function generateScalarUI(url: string, options: Omit<GenerateScalarUIOptions, "url"> = {}) {
return `
<!doctype html>
<html>
Expand All @@ -15,11 +70,15 @@ export function generateScalarUI(url: string) {
content="width=device-width, initial-scale=1" />
</head>
<body>
<script
id="api-reference"
data-url="${url}"
data-proxy-url="https://proxy.scalar.com"></script>
<div id="app"></div>
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
<script>
Scalar.createApiReference("#app", {
url: "${url}",
proxyUrl: "https://proxy.scalar.com",
...${JSON.stringify(options)}
});
</script>
</body>
</html>
`;
Expand Down
Loading