Skip to content

Update openapi.md scalar documentation #651

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 2 commits into
base: main
Choose a base branch
from
Open

Update openapi.md scalar documentation #651

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af8c3d7
Update openapi.md scalar documentation
jmcudd Oct 8, 2025
625a309
Update openapi.md
jmcudd Oct 8, 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
15 changes: 15 additions & 0 deletions docs/plugins/openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,21 @@ Additional OpenAPI reference for each endpoint

Scalar configuration, refers to [Scalar config](https://github.com/scalar/scalar/blob/main/documentation/configuration.md)

### Self-hosted Scalar bundle

Self-host the Scalar bundle and disable CDN Fonts.

Note: `cdn` is an Elysia OpenAPI plugin option (not part of Scalar’s own config); it overrides the URI to the Scalar bundle.

```typescript
openapi({
scalar: {
cdn: "/public/scalar-standalone.min.js", // plugin override for Scalar bundle URI (self-hosted)
withDefaultFonts: false, // disable Scalar’s default font CDN
},
})
```

## specPath

@default '/${path}/json'
Expand Down