Self-host scalar
release-2026-11-16-44f7c9bOpenAPI reference docs and API client
$ docker run -p 8080:8080 -e API_REFERENCE_CONFIG='{"sources":[{"url": "https://registry.scalar.com/@scalar/apis/galaxy?format=json"}],"theme": "purple"}' scalarapi/api-reference:latest- Stars
- 16 412
- Port
- 8080 (HTTP UI of the self-hosted API Reference container (mapped 8080:8080))
scalarapi/api-referenceWhat is scalar?
Scalar is an open-source toolkit for publishing and trying out HTTP APIs. The heart of it is the API Reference, a JavaScript widget that takes an OpenAPI or Swagger file and turns it into browsable documentation where every operation can be executed and where request snippets are produced for numerous languages. That widget can be embedded with a CDN script tag, wired into dozens of web frameworks through dedicated plugins, or run standalone as the scalarapi/api-reference container, which listens on 8080, picks up OpenAPI and AsyncAPI files you mount at /docs, reads a JSON config from an environment variable, honours a subpath prefix for reverse proxies and answers on a health endpoint. The monorepo also holds the API Client, a desktop and browser tool that treats an OpenAPI document as its collection, adds environments, dynamic variables, pre-request scripts and assertion tests, and can ingest Swagger 2.0, Postman and cURL inputs. Rounding it out are a CLI, a mock server, an OpenAPI parser with upgrade and Markdown-export helpers, and an HTTP echo server. Team collaboration, Git sync, hosted documentation sites, SDK builds and MCP servers belong to Scalar's managed platform with free and paid tiers rather than to the container you run yourself.
scalar alternatives
HoppscotchOpen-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, InsomniaCompareHoppscotch with scalar
Hoppscotch Community EditionSelf-hosted, open-source API development ecosystem for testing REST, GraphQL, WebSocket, and MQTT APIs — a lightweight Postman alternative with PWA and desktop apps.CompareHoppscotch Community Edition with scalar
Open ResponsesA self-hosted, open-source server implementing the OpenAI Responses API specification with support for multiple LLM providers and the Agents SDK.CompareOpen Responses with scalar
homarr-iframesSelf-hosted Go API generating embeddable iFrames for 17+ services like Linkwarden, Vikunja, Overseerr, Sonarr, Radarr, Uptime Kuma — works in any dashboard.Comparehomarr-iframes with scalar
DocusealOpen-source, self-hosted DocuSign alternative for creating fillable PDF forms and collecting digital signatures via a mobile-friendly web tool.CompareDocuseal with scalar
AppwriteThe open-source cloud for agents & devs. Including Auth, Databases, Storage, Functions, Messaging, Hosting, Realtime, WAF and moreCompareAppwrite with scalar
YaadeOpen-source, self-hosted Postman alternative for teams: shared API collections, environments, scripts, OAuth2/OIDC login, and code export, run via Docker.CompareYaade with scalar
swiftwaveSwiftWave: self-hosted open source PaaS for deploying apps on any server. Alternative to Heroku/Netlify/Render with 1GB RAM min and integrated app store.Compareswiftwave with scalar
Should you self-host scalar?
scalar scores 76/100 on selfhost.directory (how scoring works) and ranks #3 of 12 in API. It has 16 412 GitHub stars, +161 in the last 30 days.
It shipped 52 stable releases in the past year. The latest, release-2026-11-16-44f7c9b, came out on 16 November 2026. New versions land roughly every 3 days.
Setup is easy: most people get it running in one sitting. An official Docker image is available. It is MIT-licensed and written mostly in Typescript.
Its closest alternative on selfhost.directory is Hoppscotch Community Edition (84/100, 80 829 stars). It scores higher overall, so compare the two before you pick. See scalar vs Hoppscotch Community Edition side by side.
Features
- AsyncAPI support
- Built-in API testing tool
- Container health check
- Environments and variables
- Generated code examples
- Import from OpenAPI, Postman or cURL
- Live spec sync (watch mode)
- Offline-first API client
- OpenAPI/Swagger documentation rendering
- Pre-request Scripts
- Response tests
- Theming
- Two layouts
scalar README
How to install scalar
Install scalar with Docker
API_REFERENCE_CONFIG, BASE_PATH, CDN_URLdocker run \
-p 8080:8080 \
-e API_REFERENCE_CONFIG='{"sources":[{"url": "https://registry.scalar.com/@scalar/apis/galaxy?format=json"}],"theme": "purple"}' \
scalarapi/api-reference:latest
Either API_REFERENCE_CONFIG must be set OR documents must be mounted to /docs. Visit http://localhost:8080 to see your API reference.
Install scalar with Docker Compose
API_REFERENCE_CONFIGservices:
api-reference:
image: scalarapi/api-reference:latest
ports:
- "8080:8080"
volumes:
# Mount your OpenAPI and AsyncAPI documents directory
- ./docs:/docs
environment:
# Optional: Add global configuration like theme
# API_REFERENCE_CONFIG: |
# {
# "theme": "purple"
# }
restart: unless-stopped
How to configure scalar
API_REFERENCE_CONFIGJSON configuration for the API ReferenceBASE_PATHURL prefix when serving under a subpath (for example /docs); only changes the URLs the client requests, the reverse proxy must still strip the prefixCDN_URLURL for the API Reference CDN
scalar releases & version history
AI summary Added Open in browser action for GET requests
Releases
@scalar/api-client@3.26.0
Minor Changes
- #10986: Add an Open in browser action for GET requests using the configured URL and parameters.
Patch Changes
- #11041: fix: keep the auth form's rows inside their table in server-rendered markup
- #11011: Make Vite configuration imports compatible with the native config loader.
- #11041: fix: render the OAuth 2.0 redirect URL field the same way on the server and in the browser
@scalar/api-reference@1.79.0
Minor Changes
-
#10980: feat: redesign code cards as a padded shell with the code on a lifted surface
This changes the default look of every
ScalarCard, not only the cards in the API reference.ScalarCarddrops its border and dividers for a 12px shell with 4px of padding, and each plainScalarCardSectionbecomes an 8px surface lifted off it. If you use these components in your own app, check your cards after this bump:- A card recolored to match its page (for example
bg-b-1on abg-b-1page) no longer has an edge. Passborderto bring it back, or give the card a fill that differs from the page. - Two plain sections in a row are two surfaces with a 4px gap, where they were one box with a divider.
- Content placed straight in
ScalarCardwithout a section sits inside the 4px padding. Passp-0to remove it.
In the API reference, the request example, example responses, operations list and AsyncAPI cards all pick this up. The surface color is derived from
--scalar-background-2, and its outline from--scalar-shadow-1and--scalar-border-color. A copy button on a surface sits one step above it, toward the text color. Set--scalar-card-surface,--scalar-card-surface-raisedor--scalar-card-surface-shadowon.scalar-cardto change them. Every class name is unchanged, and the new rules are single-class selectors, so existing theme andcustomCssrules keep winning. - A card recolored to match its page (for example
-
#11036: Add
showDefaultClientsWithSdkInstallationto show SDK installation tabs alongside built-in HTTP clients in the introduction. -
#11033: Add
persistSelectedClientto disable saving and restoring the selected code sample client in local storage.
Patch Changes
-
#11041: fix: keep the copy link out of the tag accordion button in the classic layout, so server-rendered markup hydrates
-
#11011: Make Vite configuration imports compatible with the native config loader.
-
#11041: fix: keep the first tag open while hydrating a server-rendered reference
-
#10996: Include operation tag names and their displayed titles (
x-displayNameorsummary) in API reference search results. -
#10989: Remove the unused inline editor placeholder template and slot declaration.
-
#11027: fix: render server-rendered teleports in place until they are mounted, so hydrating the API reference no longer replaces elements of the host page or breaks its dropdowns
-
#10961: Preserve named example summaries and names in header, parameter, and body example lists as muted labels above the value boxes while copying only their values. Keep schema example objects intact when their payload contains fields named
valueorsummary.Retain raw object examples in legacy schema example maps.
@scalar/components@0.35.0
Minor Changes
-
#10980: feat: redesign code cards as a padded shell with the code on a lifted surface
This changes the default look of every
ScalarCard, not only the cards in the API reference.ScalarCarddrops its border and dividers for a 12px shell with 4px of padding, and each plainScalarCardSectionbecomes an 8px surface lifted off it. If you use these components in your own app, check your cards after this bump:- A card recolored to match its page (for example
bg-b-1on abg-b-1page) no longer has an edge. Passborderto bring it back, or give the card a fill that differs from the page. - Two plain sections in a row are two surfaces with a 4px gap, where they were one box with a divider.
- Content placed straight in
ScalarCardwithout a section sits inside the 4px padding. Passp-0to remove it.
In the API reference, the request example, example responses, operations list and AsyncAPI cards all pick this up. The surface color is derived from
--scalar-background-2, and its outline from--scalar-shadow-1and--scalar-border-color. A copy button on a surface sits one step above it, toward the text color. Set--scalar-card-surface,--scalar-card-surface-raisedor--scalar-card-surface-shadowon.scalar-cardto change them. Every class name is unchanged, and the new rules are single-class selectors, so existing theme andcustomCssrules keep winning. - A card recolored to match its page (for example
-
#11040: feat: add a medium size to ScalarToggle and ScalarTristateToggle
Pass
size="md"for a larger toggle with a 20×32px track and a 16px thumb, sized to sit next to full-height form controls in settings rows. The tristate toggle's center position scales with it. The default stayssm, so existing toggles are unchanged. The input and group wrappers keep thesmtoggle, since their form-row layout is built around it.
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
- #11027: fix: render server-rendered teleports in place until they are mounted, so hydrating the API reference no longer replaces elements of the host page or breaks its dropdowns
@scalar/json-magic@0.20.0
Minor Changes
- #11037: Load object-valued
x-codeSamples.sourceandx-code-samples.sourcefile references as raw code text, with relative origins and lazy operation loading. Retain failed references and show an unavailable sample instead of silently replacing them with an empty string. Preserve literal$refvalues in other extensions and example data.
Patch Changes
- #11015: Update Undici to address CVE-2026-116592 and allow compatible Undici 8 updates without requiring a new Scalar release.
- #11005: Preserve nested deletions and their application order when a covering parent deletion conflicts with another change.
@scalar/schemas@0.18.0
Minor Changes
- #11037: Load object-valued
x-codeSamples.sourceandx-code-samples.sourcefile references as raw code text, with relative origins and lazy operation loading. Retain failed references and show an unavailable sample instead of silently replacing them with an empty string. Preserve literal$refvalues in other extensions and example data. - #11036: Add
showDefaultClientsWithSdkInstallationto show SDK installation tabs alongside built-in HTTP clients in the introduction. - #11033: Add
persistSelectedClientto disable saving and restoring the selected code sample client in local storage.
@scalar/types@0.29.0
Minor Changes
- #11037: Load object-valued
x-codeSamples.sourceandx-code-samples.sourcefile references as raw code text, with relative origins and lazy operation loading. Retain failed references and show an unavailable sample instead of silently replacing them with an empty string. Preserve literal$refvalues in other extensions and example data. - #11036: Add
showDefaultClientsWithSdkInstallationto show SDK installation tabs alongside built-in HTTP clients in the introduction. - #11033: Add
persistSelectedClientto disable saving and restoring the selected code sample client in local storage.
Patch Changes
- #10986: Add an Open in browser action for GET requests using the configured URL and parameters.
@scalar/workspace-store@0.72.0
Minor Changes
- #11037: Load object-valued
x-codeSamples.sourceandx-code-samples.sourcefile references as raw code text, with relative origins and lazy operation loading. Retain failed references and show an unavailable sample instead of silently replacing them with an empty string. Preserve literal$refvalues in other extensions and example data.
Patch Changes
- #10998: Reuse the discovery response when importing extensionless API description URLs, avoiding a duplicate download while preserving URL metadata and subsequent fetches.
@scalar/fastify-api-reference@1.79.0
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/nextjs-api-reference@0.12.19
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/nuxt@0.6.91
Patch Changes
- #11057: Update @nuxt/kit and @nuxt/schema to 4.6.4 to keep the module utilities and schema types aligned.
@scalar/agent-chat@0.12.53
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
- #11035: Update the AI SDK dependencies to remove their transitive Undici dependency.
@scalar/api-client-react@2.0.67
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/api-reference-react@0.9.91
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/asyncapi-to-markdown@0.2.9
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/blocks@0.7.2
Patch Changes
-
#11011: Make Vite configuration imports compatible with the native config loader.
-
#10980: feat: redesign code cards as a padded shell with the code on a lifted surface
This changes the default look of every
ScalarCard, not only the cards in the API reference.ScalarCarddrops its border and dividers for a 12px shell with 4px of padding, and each plainScalarCardSectionbecomes an 8px surface lifted off it. If you use these components in your own app, check your cards after this bump:- A card recolored to match its page (for example
bg-b-1on abg-b-1page) no longer has an edge. Passborderto bring it back, or give the card a fill that differs from the page. - Two plain sections in a row are two surfaces with a 4px gap, where they were one box with a divider.
- Content placed straight in
ScalarCardwithout a section sits inside the 4px padding. Passp-0to remove it.
In the API reference, the request example, example responses, operations list and AsyncAPI cards all pick this up. The surface color is derived from
--scalar-background-2, and its outline from--scalar-shadow-1and--scalar-border-color. A copy button on a surface sits one step above it, toward the text color. Set--scalar-card-surface,--scalar-card-surface-raisedor--scalar-card-surface-shadowon.scalar-cardto change them. Every class name is unchanged, and the new rules are single-class selectors, so existing theme andcustomCssrules keep winning. - A card recolored to match its page (for example
-
#11037: Load object-valued
x-codeSamples.sourceandx-code-samples.sourcefile references as raw code text, with relative origins and lazy operation loading. Retain failed references and show an unavailable sample instead of silently replacing them with an empty string. Preserve literal$refvalues in other extensions and example data. -
#11041: fix: render the first request example on the server
-
#10961: Preserve named example summaries and names in header, parameter, and body example lists as muted labels above the value boxes while copying only their values. Keep schema example objects intact when their payload contains fields named
valueorsummary.Retain raw object examples in legacy schema example maps.
-
#11002: Use shared multi-type schema definitions when formatting array union labels.
@scalar/code-highlight@0.4.14
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/draggable@0.4.8
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/icons@0.7.9
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/mermaid-plugin@0.1.8
Patch Changes
- #11032: Update Mermaid to use a patched KaTeX dependency.
@scalar/openapi-to-markdown@1.7.7
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/openapi-upgrader@0.4.10
Patch Changes
- #10952: Fix shared Swagger 2.0 body and form-data parameters being left in parameter arrays instead of request bodies. Preserve operation media types, combine form fields, and inherit path-level bodies regardless of property order.
@scalar/openapi-validator@0.1.21
Patch Changes
-
#11008: Report duplicate operation IDs in active paths, webhooks and callbacks, including local references.
Reusing a callback or Path Item component in multiple locations now reports duplicate operation IDs when the component's operations declare an
operationId. Each reference is checked as a separate occurrence in the API. Give those operations unique IDs at each location, or omit their optionaloperationIdfields when sharing the component. -
#11009: Reject duplicate parameter names and locations within each parameter list while preserving operation-level overrides.
-
#11010: Reject server variable defaults outside their enum values in OpenAPI 3.1 and 3.2, while preserving OpenAPI 3.0 behavior.
@scalar/postman-to-openapi@0.7.32
Patch Changes
-
#11055: fix: wrap saved response bodies in an example object
Saved Postman responses were written straight into
examples.default, so the converted document failed OpenAPI 3.1 validation and tools readingexamples.default.valuegot nothing. The body now goes intovalue, the same way request body examples already work. Non-JSON bodies are kept as plain strings instead of{ rawContent }objects.
@scalar/pre-post-request-scripts@0.4.65
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/react-renderer@0.4.6
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/sidebar@0.12.10
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/snippetz@0.10.18
Patch Changes
-
#10981: Remove unnecessary curl_close from php
-
#11048: Escape the request URL in the fetch, ofetch, undici, Guzzle, PHP cURL, Dart, Requests and HTTPX snippets, the method in the Guzzle and PHP cURL snippets, the Basic auth credentials in the PHP cURL and Dart snippets, array keys in the PHP snippets, and
#{,#$and#@interpolation in the Ruby snippet. -
#11056: fix(snippetz): keep Ruby request bodies as written
The
ruby/nativeJSON body now uses a quoted heredoc (<<~'JSON'), so Ruby no longer turns\"into",\\into\, or runs#{}inside the payload. String bodies (the JSON fallback,application/octet-streamand other text types) also escape a#that would start#{},#$or#@interpolation.
@scalar/themes@0.20.1
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/use-toasts@0.10.7
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
@scalar/validation@0.6.8
Patch Changes
- #11003: Choose record union branches by matching values to avoid coercing valid entries through an incompatible branch.
@scalar/void-server@2.5.23
Patch Changes
- #11032: Update the Hono Node adapter to fix request path handling and WebSocket upgrade vulnerabilities.
@scalar/astro@0.4.38
No changes in this release.
@scalar/docusaurus@0.8.59
No changes in this release.
@scalar/express-api-reference@0.10.38
No changes in this release.
@scalar/hono-api-reference@0.12.21
No changes in this release.
@scalar/nestjs-api-reference@1.2.38
No changes in this release.
@scalar/starlight@0.2.23
No changes in this release.
@scalar/sveltekit@0.3.38
No changes in this release.
@scalar/asyncapi-validator@0.1.21
No changes in this release.
@scalar/client-side-rendering@0.4.20
No changes in this release.
@scalar/core@0.5.52
No changes in this release.
@scalar/json-schema-validator@0.1.21
No changes in this release.
@scalar/mock-server@0.21.3
No changes in this release.
@scalar/nextjs-openapi@0.3.59
No changes in this release.
@scalar/oas-utils@0.20.22
No changes in this release.
@scalar/openapi-parser@0.29.23
No changes in this release.
@scalar/server-side-rendering@0.1.70
No changes in this release.
@scalar/use-hooks@0.4.26
No changes in this release.
@scalar/aspire@1.0.0
Bundled API Reference
- @scalar/api-reference@1.79.0
Major Changes
- #10975: feat!: drop .NET 8 and .NET 9 support (both reached end of support on November 10, 2026); packages now target .NET 10 and later
Minor Changes
- #11036: Expose
showDefaultClientsWithSdkInstallationthrough the Python, Java, and .NET integrations to show built-in HTTP clients alongside SDK installation tabs. - #11033: Expose the selected code sample client persistence option in .NET, Java, FastAPI, and Django Ninja. Disable it to avoid reading or writing the selected-client local storage key while keeping page-local selection available.
@scalar/aspnetcore@3.0.0
Bundled API Reference
- @scalar/api-reference@1.79.0
Major Changes
- #10975: feat!: drop .NET 8 and .NET 9 support (both reached end of support on November 10, 2026); packages now target .NET 10 and later
Minor Changes
- #11036: Expose
showDefaultClientsWithSdkInstallationthrough the Python, Java, and .NET integrations to show built-in HTTP clients alongside SDK installation tabs. - #11033: Expose the selected code sample client persistence option in .NET, Java, FastAPI, and Django Ninja. Disable it to avoid reading or writing the selected-client local storage key while keeping page-local selection available.
@scalar/aws-lambda@1.0.0
Bundled API Reference
- @scalar/api-reference@1.79.0
Major Changes
- #10975: feat!: drop .NET 8 and .NET 9 support (both reached end of support on November 10, 2026); packages now target .NET 10 and later
Minor Changes
- #11036: Expose
showDefaultClientsWithSdkInstallationthrough the Python, Java, and .NET integrations to show built-in HTTP clients alongside SDK installation tabs. - #11033: Expose the selected code sample client persistence option in .NET, Java, FastAPI, and Django Ninja. Disable it to avoid reading or writing the selected-client local storage key while keeping page-local selection available.
@scalar/azure-functions@1.0.0
Bundled API Reference
- @scalar/api-reference@1.79.0
Major Changes
- #10975: feat!: drop .NET 8 and .NET 9 support (both reached end of support on November 10, 2026); packages now target .NET 10 and later
Minor Changes
- #11036: Expose
showDefaultClientsWithSdkInstallationthrough the Python, Java, and .NET integrations to show built-in HTTP clients alongside SDK installation tabs. - #11033: Expose the selected code sample client persistence option in .NET, Java, FastAPI, and Django Ninja. Disable it to avoid reading or writing the selected-client local storage key while keeping page-local selection available.
@scalar/dotnet-shared@1.0.0
Major Changes
- #10975: feat!: drop .NET 8 and .NET 9 support (both reached end of support on November 10, 2026); packages now target .NET 10 and later
Minor Changes
- #11036: Expose
showDefaultClientsWithSdkInstallationthrough the Python, Java, and .NET integrations to show built-in HTTP clients alongside SDK installation tabs. - #11033: Expose the selected code sample client persistence option in .NET, Java, FastAPI, and Django Ninja. Disable it to avoid reading or writing the selected-client local storage key while keeping page-local selection available.
scalar-ninja@0.4.0
Minor Changes
- #11036: Expose
showDefaultClientsWithSdkInstallationthrough the Python, Java, and .NET integrations to show built-in HTTP clients alongside SDK installation tabs. - #11033: Expose the selected code sample client persistence option in .NET, Java, FastAPI, and Django Ninja. Disable it to avoid reading or writing the selected-client local storage key while keeping page-local selection available.
scalar-fastapi@1.10.0
Minor Changes
- #11036: Expose
showDefaultClientsWithSdkInstallationthrough the Python, Java, and .NET integrations to show built-in HTTP clients alongside SDK installation tabs. - #11033: Expose the selected code sample client persistence option in .NET, Java, FastAPI, and Django Ninja. Disable it to avoid reading or writing the selected-client local storage key while keeping page-local selection available.
@scalar/java-integration@0.8.0
Bundled API Reference
- @scalar/api-reference@1.79.0
Minor Changes
- #11036: Expose
showDefaultClientsWithSdkInstallationthrough the Python, Java, and .NET integrations to show built-in HTTP clients alongside SDK installation tabs. - #11033: Expose the selected code sample client persistence option in .NET, Java, FastAPI, and Django Ninja. Disable it to avoid reading or writing the selected-client local storage key while keeping page-local selection available.
scalar_api_reference@0.2.25
Bundled API Reference
- @scalar/api-reference@1.79.0
Patch Changes
-
#11058: Prevent HTML injection in embedded Rust configuration and bundle URLs, and preserve literal template placeholders in user data.
Make the raw
render_scalarhelper internal so callers cannot bypass JSON validation. Usescalar_htmlwith aserde_json::Valueorscalar_html_from_jsonwith a JSON string instead.
@scalar/mock-server-docker@0.2.80
Patch Changes
- #11032: Update the Hono Node adapter to fix request path handling and WebSocket upgrade vulnerabilities.
scalar-app@1.1.50
Patch Changes
- #11011: Make Vite configuration imports compatible with the native config loader.
- #10999: Upgrade the Scalar SDK to 0.7.0 and adapt registry requests to its updated method parameters.
- #11015: Update Undici to address CVE-2026-116592 and allow compatible Undici 8 updates without requiring a new Scalar release.
- #10998: Reuse the discovery response when importing extensionless API description URLs, avoiding a duplicate download while preserving URL metadata and subsequent fetches.
@scalarapi/docker-api-reference@0.6.25
Bundled API Reference
- @scalar/api-reference@1.79.0
No changes in this release.
AI summary YAML merge key limit increased
Releases
@scalar/helpers@0.18.0
Minor Changes
-
#10967: fix: parse YAML documents that merge shared anchors into many operations
Since yaml 2.9.1, merge keys (
<<: *anchor) count toward the alias limit, so large API Gateway exports failed with "Excessive alias count indicates a resource exhaustion attack". The limit is now 100,000 and shared throughYAML_MAX_ALIAS_COUNTfrom@scalar/helpers.
Patch Changes
- #10979: Preserve question marks inside query values when merging a URL and path.
@scalar/fastify-api-reference@1.78.1
Patch Changes
- #10977: Use the API title for JSON and YAML download filenames, encoding Unicode titles safely in the response headers.
@scalar/api-client@3.25.1
Patch Changes
- #10967: Use the shared YAML alias limit when editing structured YAML request bodies.
@scalar/api-reference@1.78.1
Patch Changes
-
#10967: Use the shared YAML alias limit when rendering RAML and Avro schemas.
-
#10967: fix: parse YAML documents that merge shared anchors into many operations
Since yaml 2.9.1, merge keys (
<<: *anchor) count toward the alias limit, so large API Gateway exports failed with "Excessive alias count indicates a resource exhaustion attack". The limit is now 100,000 and shared throughYAML_MAX_ALIAS_COUNTfrom@scalar/helpers.
@scalar/blocks@0.7.1
Patch Changes
- #10990: Use the canonical
jstarget when generating JavaScript code examples.
@scalar/galaxy@0.7.3
Patch Changes
- #10967: Use the shared YAML alias limit when generating JSON example documents.
@scalar/import@0.5.37
Patch Changes
- #10967: Use the shared YAML alias limit when importing API descriptions from URLs and embedded content.
@scalar/json-magic@0.19.1
Patch Changes
-
#10967: fix: parse YAML documents that merge shared anchors into many operations
Since yaml 2.9.1, merge keys (
<<: *anchor) count toward the alias limit, so large API Gateway exports failed with "Excessive alias count indicates a resource exhaustion attack". The limit is now 100,000 and shared throughYAML_MAX_ALIAS_COUNTfrom@scalar/helpers.
@scalar/json-schema-validator@0.1.20
Patch Changes
- #10967: Use the shared YAML alias limit when validating YAML documents.
@scalar/mock-server@0.21.2
Patch Changes
- #10937: fix: generate valid base64 examples for
format: byteandcontentEncoding: base64/base64urlstrings
@scalar/oas-utils@0.20.21
Patch Changes
-
#10967: fix: parse YAML documents that merge shared anchors into many operations
Since yaml 2.9.1, merge keys (
<<: *anchor) count toward the alias limit, so large API Gateway exports failed with "Excessive alias count indicates a resource exhaustion attack". The limit is now 100,000 and shared throughYAML_MAX_ALIAS_COUNTfrom@scalar/helpers.
@scalar/openapi-parser@0.29.22
Patch Changes
-
#10967: fix: parse YAML documents that merge shared anchors into many operations
Since yaml 2.9.1, merge keys (
<<: *anchor) count toward the alias limit, so large API Gateway exports failed with "Excessive alias count indicates a resource exhaustion attack". The limit is now 100,000 and shared throughYAML_MAX_ALIAS_COUNTfrom@scalar/helpers.
@scalar/workspace-store@0.71.1
Patch Changes
- #10937: fix: generate valid base64 examples for
format: byteandcontentEncoding: base64/base64urlstrings
@scalar/astro@0.4.37
No changes in this release.
@scalar/docusaurus@0.8.58
No changes in this release.
@scalar/express-api-reference@0.10.37
No changes in this release.
@scalar/hono-api-reference@0.12.20
No changes in this release.
@scalar/nestjs-api-reference@1.2.37
No changes in this release.
@scalar/nextjs-api-reference@0.12.18
No changes in this release.
@scalar/nuxt@0.6.90
No changes in this release.
@scalar/starlight@0.2.22
No changes in this release.
@scalar/sveltekit@0.3.37
No changes in this release.
@scalar/agent-chat@0.12.52
No changes in this release.
@scalar/api-client-react@2.0.66
No changes in this release.
@scalar/api-reference-react@0.9.90
No changes in this release.
@scalar/asyncapi-to-markdown@0.2.8
No changes in this release.
@scalar/asyncapi-upgrader@0.1.21
No changes in this release.
@scalar/asyncapi-validator@0.1.20
No changes in this release.
@scalar/client-side-rendering@0.4.19
No changes in this release.
@scalar/components@0.34.1
No changes in this release.
@scalar/core@0.5.51
No changes in this release.
@scalar/localization@0.2.12
No changes in this release.
@scalar/mermaid-plugin@0.1.7
No changes in this release.
@scalar/nextjs-openapi@0.3.58
No changes in this release.
@scalar/object-utils@1.3.36
No changes in this release.
@scalar/openapi-to-markdown@1.7.6
No changes in this release.
@scalar/openapi-upgrader@0.4.9
No changes in this release.
@scalar/openapi-validator@0.1.20
No changes in this release.
@scalar/postman-to-openapi@0.7.31
No changes in this release.
@scalar/pre-post-request-scripts@0.4.64
No changes in this release.
@scalar/release-notes@0.3.1
No changes in this release.
@scalar/schemas@0.17.1
No changes in this release.
@scalar/server-side-rendering@0.1.69
No changes in this release.
@scalar/sidebar@0.12.9
No changes in this release.
@scalar/snippetz@0.10.17
No changes in this release.
@scalar/types@0.28.1
No changes in this release.
@scalar/use-hooks@0.4.25
No changes in this release.
@scalar/void-server@2.5.22
No changes in this release.
@scalar/aspire@0.15.0
Bundled API Reference
- @scalar/api-reference@1.78.1
Minor Changes
- #10974: feat: add .NET 11 support (
net11.0target framework)
Patch Changes
- #10973: Update Aspire.Hosting to 13.6.5 and MessagePack to 2.5.307 to resolve security advisories and NuGet package downgrade errors. Use Aspire's renamed Services property in resource configuration.
@scalar/aspnetcore@2.21.0
Bundled API Reference
- @scalar/api-reference@1.78.1
Minor Changes
- #10974: feat: add .NET 11 support (
net11.0target framework)
@scalar/aws-lambda@0.6.0
Bundled API Reference
- @scalar/api-reference@1.78.1
Minor Changes
- #10974: feat: add .NET 11 support (
net11.0target framework)
@scalar/azure-functions@0.6.0
Bundled API Reference
- @scalar/api-reference@1.78.1
Minor Changes
- #10974: feat: add .NET 11 support (
net11.0target framework)
@scalar/dotnet-shared@0.6.0
Minor Changes
- #10974: feat: add .NET 11 support (
net11.0target framework)
scalar-ninja@0.3.3
Patch Changes
- #10994: Publish a new patch release through PyPI trusted publishing to recover from the previous failed uploads.
scalar-fastapi@1.9.3
Patch Changes
- #10994: Publish a new patch release through PyPI trusted publishing to recover from the previous failed uploads.
scalar-app@1.1.49
Patch Changes
- #10988: Use the shared theme reset for link text decoration.
- #10967: Use the shared YAML alias limit when parsing YAML in the collection editor.
@scalarapi/docker-api-reference@0.6.24
Bundled API Reference
- @scalar/api-reference@1.78.1
No changes in this release.
@scalar/java-integration@0.7.2
Bundled API Reference
- @scalar/api-reference@1.78.1
No changes in this release.
scalar_api_reference@0.2.24
Bundled API Reference
- @scalar/api-reference@1.78.1
No changes in this release.
@scalar/mock-server-docker@0.2.79
No changes in this release.
Releases
@scalar/api-client@3.25.0
Minor Changes
-
#10871: Add schema-aware file controls for multipart/mixed and multipart/related parts, preserving part order and encodings. Restrict multipart/form-data uploads to file fields when a request body schema is available.
Honor binary encoding content types on multipart fields and share file-schema detection with example generation, including nullable, composed, and typeless file placeholders.
-
#10731: Support OpenID Connect flow defaults, including client ID, selected scopes, and PKCE, after discovery. Prefer a sole configured flow while retaining other discovered flows. Add typed OpenID Connect authentication configuration for .NET.
@scalar/api-reference@1.78.0
Minor Changes
- #10892: Allow defaultHttpClient to select custom code samples with targetKey: 'custom'.
- #10891: Support optional display labels for SDK installation tabs while retaining language-based selection and icons.
- #10902: Render self-contained Avro, RAML, and Protobuf schemas as native field and type documentation, retaining copyable source for unsupported schemas.
Patch Changes
-
#10890: Add an Elixir language icon and show it on Elixir SDK installation tabs.
-
#10936: Mark hosting waitlist sign-ups from the developer tools Deploy card with an
osscontact property. -
#10898: Preserve browser-native plugin URL imports when bundling API Reference with Next.js Turbopack.
-
#10908: Expose
Scalar.releaseUnusedStyles()in the standalone bundle to release orphaned CSS without mounting a temporary reference or changing body theme classes. Preserve styles owned by active references and restore detached styles on the next mount. -
#10873: Display the API description version verbatim without adding a
vprefix, so commit hashes and other version identifiers remain accurate. -
#10874: Automatically group deep-object query parameters with expandable fields in a collapsed row.
Keep expanded fields open during navigation within a group, and mark flattened fields as required only when every ancestor is required.
-
#10949: Show response header examples, including media type examples and OpenAPI 3.2 cookie examples, with explicit examples taking precedence over schema examples. Preserve this precedence through composed schemas and fall back to media type examples when header examples have no usable values.
Keep external example URLs visible and preserve line breaks in displayed string examples. Across all schemas, array-level examples take precedence over item examples.
Preserve
x-exampleandx-exampleson OpenAPI 2.0 response headers during upgrades.
@scalar/blocks@0.7.0
Minor Changes
- #10894: Substitute explicitly mapped reader credentials into custom code samples with default masking, public field opt-outs, and real values on copy.
- #10893: Allow custom code samples to use separate picker headings with an optional
groupfield.
Patch Changes
-
#10949: Show response header examples, including media type examples and OpenAPI 3.2 cookie examples, with explicit examples taking precedence over schema examples. Preserve this precedence through composed schemas and fall back to media type examples when header examples have no usable values.
Keep external example URLs visible and preserve line breaks in displayed string examples. Across all schemas, array-level examples take precedence over item examples.
Preserve
x-exampleandx-exampleson OpenAPI 2.0 response headers during upgrades. -
#10902: Render self-contained Avro, RAML, and Protobuf schemas as native field and type documentation, retaining copyable source for unsupported schemas.
@scalar/components@0.34.0
Minor Changes
- #10894: Substitute explicitly mapped reader credentials into custom code samples with default masking, public field opt-outs, and real values on copy.
- #10890: Add an Elixir language icon and show it on Elixir SDK installation tabs.
@scalar/json-magic@0.19.0
Minor Changes
- #10897: Resolve proxy references within their schema resource using the shared bundle resolver, and expose resolved targets to lifecycle hooks for scope-aware transformations.
Patch Changes
- #10904: Share confined document loading between Markdown converters and include HTTP status codes in load errors.
@scalar/release-notes@0.3.0
Minor Changes
- #10935: feat(release-notes): add a per-product
maxHighlightsoption (1 to 20, default 5) that sets how many highlights a generated note may carry. The limit is stated in the default system prompt, enforced when the response is validated, and passed to custom system prompts, and the default output token budget grows with it.
Patch Changes
- #10900: Upgrade the CLI to Commander 15 and require Node.js 22.12.0 or later.
@scalar/schemas@0.17.0
Minor Changes
- #10894: Substitute explicitly mapped reader credentials into custom code samples with default masking, public field opt-outs, and real values on copy.
- #10892: Allow defaultHttpClient to select custom code samples with targetKey: 'custom'.
- #10891: Support optional display labels for SDK installation tabs while retaining language-based selection and icons.
- #10893: Allow custom code samples to use separate picker headings with an optional
groupfield.
@scalar/types@0.28.0
Minor Changes
- #10894: Substitute explicitly mapped reader credentials into custom code samples with default masking, public field opt-outs, and real values on copy.
- #10892: Allow defaultHttpClient to select custom code samples with targetKey: 'custom'.
- #10891: Support optional display labels for SDK installation tabs while retaining language-based selection and icons.
- #10731: Support OpenID Connect flow defaults, including client ID, selected scopes, and PKCE, after discovery. Prefer a sole configured flow while retaining other discovered flows. Add typed OpenID Connect authentication configuration for .NET.
- #10893: Allow custom code samples to use separate picker headings with an optional
groupfield.
Patch Changes
-
#10871: Add schema-aware file controls for multipart/mixed and multipart/related parts, preserving part order and encodings. Restrict multipart/form-data uploads to file fields when a request body schema is available.
Honor binary encoding content types on multipart fields and share file-schema detection with example generation, including nullable, composed, and typeless file placeholders.
@scalar/workspace-store@0.71.0
Minor Changes
-
#10894: Substitute explicitly mapped reader credentials into custom code samples with default masking, public field opt-outs, and real values on copy.
-
#10871: Add schema-aware file controls for multipart/mixed and multipart/related parts, preserving part order and encodings. Restrict multipart/form-data uploads to file fields when a request body schema is available.
Honor binary encoding content types on multipart fields and share file-schema detection with example generation, including nullable, composed, and typeless file placeholders.
-
#10891: Support optional display labels for SDK installation tabs while retaining language-based selection and icons.
-
#10731: Support OpenID Connect flow defaults, including client ID, selected scopes, and PKCE, after discovery. Prefer a sole configured flow while retaining other discovered flows. Add typed OpenID Connect authentication configuration for .NET.
-
#10893: Allow custom code samples to use separate picker headings with an optional
groupfield.
Patch Changes
-
#10928: Fill the discriminator property with the selected variant's mapping value in generated examples.
-
#10813: fix: keep the required properties of an object that the example depth cap truncates, so a deeply nested mock response no longer serves
{}where its schema requires keys, including keys required throughallOfmembers or the selectedoneOf/anyOfvariantPreserve explicit values equal to the depth marker and exclude requirements from unselected union branches.
Keep required primitive compositions on the normal traversal and collect discriminator requirements from the branch rendered after depth truncation.
Reuse evaluated discriminator values for required-property collection and keep inferred tuple arrays empty past the depth cap.
Preserve shared requirements and required primitive values through dynamic references, including requirements declared in dynamically referenced composition members.
Collect requirements separately when composition branches reuse a shared template under different dynamic bindings.
Exclude requirements from composition members omitted by the request or response mode.
-
#10938: fix: merge array items whose
allOfdescribes an object withouttype: objecton the first member into one example instead of one partial object per member -
#10955: fix: respect array length bounds when generating schema examples
Preserve cycle detection for selected array branches, pad unrestricted annotated items, and prefer a contains sample when no item constraints are declared.
@scalar/docusaurus@0.8.57
Patch Changes
-
#10908: Load Scalar only on API reference routes and destroy its instances when leaving, preventing standalone styles from affecting other Docusaurus pages.
The CDN bundle is no longer injected on every page. Sites using
window.Scalar.createApiReferenceoutside an API reference route must load the bundle explicitly. Upgrade pinned CDN bundles to a release withScalar.releaseUnusedStylesfor cleanup when navigation interrupts loading.
@scalar/agent-chat@0.12.51
Patch Changes
- #10879: Omit response URLs and redact saved credentials from response headers and bodies before sending request tool output to the chat model.
- #10876: Require approval before executing any AI-generated API request, including GET requests that can send stored credentials or data.
- #10878: Validate AI request paths and require a usable selected server before attaching stored credentials or sending a request.
@scalar/asyncapi-to-markdown@0.2.7
Patch Changes
- #10904: Block private-network document requests by default and require an explicit basePath for local files. Apply the same permissions to external references, with an opt-in for trusted private-network inputs.
- #10904: Share confined document loading between Markdown converters and include HTTP status codes in load errors.
@scalar/code-highlight@0.4.13
Patch Changes
- #10923: Update the bundled mdast-util-to-hast to 13.2.1 to fix CVE-2025-66400 (unsanitized class attribute).
@scalar/helpers@0.17.1
Patch Changes
- #10894: Substitute explicitly mapped reader credentials into custom code samples with default masking, public field opt-outs, and real values on copy.
- #10882: Skip proxying requests whose origin matches the proxy origin to avoid an unnecessary forwarding hop.
- #10880: Preserve empty upstream response headers when restoring headers for scripts, request history, and agent results.
@scalar/json-schema-validator@0.1.19
Patch Changes
- #10951: Use shortest round-trip decimal values consistently for multipleOf checks, including large JSON integers and positive exponents. Fast-path safe integers and share keyword registration across validators.
- #10951: Validate decimal
multipleOfconstraints with exact decimal arithmetic, accepting values such as19.99and1000000.19formultipleOf: 0.01while rejecting nonmultiples without a floating-point tolerance. - #10959: Reduce repeated schema compilation in decimal validation tests to avoid CI timeouts.
@scalar/mock-server@0.21.1
Patch Changes
-
#10951: Use shortest round-trip decimal values consistently for multipleOf checks, including large JSON integers and positive exponents. Fast-path safe integers and share keyword registration across validators.
-
#10951: Validate decimal
multipleOfconstraints with exact decimal arithmetic, accepting values such as19.99and1000000.19formultipleOf: 0.01while rejecting nonmultiples without a floating-point tolerance. -
#10813: fix: keep the required properties of an object that the example depth cap truncates, so a deeply nested mock response no longer serves
{}where its schema requires keys, including keys required throughallOfmembers or the selectedoneOf/anyOfvariantPreserve explicit values equal to the depth marker and exclude requirements from unselected union branches.
Keep required primitive compositions on the normal traversal and collect discriminator requirements from the branch rendered after depth truncation.
Reuse evaluated discriminator values for required-property collection and keep inferred tuple arrays empty past the depth cap.
Preserve shared requirements and required primitive values through dynamic references, including requirements declared in dynamically referenced composition members.
Collect requirements separately when composition branches reuse a shared template under different dynamic bindings.
Exclude requirements from composition members omitted by the request or response mode.
-
#10950: Ignore declared Content-Length, Content-Encoding, and Content-Type response headers so generated bodies remain readable and empty responses do not inherit a declared content type.
Ignore other transport-managed headers, including Transfer-Encoding and Trailer. Skip and warn about malformed declared header names and values instead of failing the response.
-
#10938: fix: merge array items whose
allOfdescribes an object withouttype: objecton the first member into one example instead of one partial object per member -
#10940: Route path segments that mix parameters with literal text, such as
{id}.json,{id}:cancelandv{version}, only to requests that carry the literal text, and pass their parameters to request validation,x-handlerandx-variable. -
#10930: Accept request bodies that leave out required
readOnlyproperties during request validation. -
#10875: Keep mock store collections and item IDs isolated from inherited host properties, and validate keys passed through the script sandbox.
@scalar/nextjs-openapi@0.3.57
Patch Changes
-
#10898: Preserve path parameters when generating OpenAPI descriptions from Next.js handlers with asynchronous params, and mark path parameters as required.
Infer missing path parameters from route paths when handlers use named parameter aliases or generated Next.js RouteContext types.
@scalar/openapi-to-markdown@1.7.5
Patch Changes
- #10904: Share confined document loading between Markdown converters and include HTTP status codes in load errors.
@scalar/openapi-types@0.9.9
Patch Changes
- #10921: Isolate declaration compatibility tests from ambient workspace types.
@scalar/openapi-upgrader@0.4.8
Patch Changes
-
#10736: Exclude benchmark fixtures from published build output.
-
#10925: Keep
type: fileinside Swagger 2.0 example data when upgrading to OpenAPI 3.0. Continue converting file schemas in reusable responses and parameters named like data keywords. Preserve example and default data on schemas and reusable parameters whose names match schema-map keywords. Continue upgrading response headers whose names match data keywords. Limit Swagger-specific data guards to the 2.0 upgrade so OpenAPI 3.0 request bodies and callbacks namedx-examplestill upgrade. Preserve example payloads on reusable objects namedheaders. -
#10948: Convert Swagger 2.0 discriminator strings to Discriminator Objects so upgrades preserve the discriminating property name.
Preserve x-ms-discriminator-value and x-discriminator-value aliases from allOf subtypes in discriminator mappings, including inherited subtypes, without replacing authored mappings.
-
#10949: Show response header examples, including media type examples and OpenAPI 3.2 cookie examples, with explicit examples taking precedence over schema examples. Preserve this precedence through composed schemas and fall back to media type examples when header examples have no usable values.
Keep external example URLs visible and preserve line breaks in displayed string examples. Across all schemas, array-level examples take precedence over item examples.
Preserve
x-exampleandx-exampleson OpenAPI 2.0 response headers during upgrades. -
#10920: Prefer operation-level
producesover the globalproduceswhen upgrading Swagger 2.0 response content.
@scalar/snippetz@0.10.16
Patch Changes
- #10942: Keep application/x-www-form-urlencoded bodies in the ofetch and undici snippets, preserve the order of repeated, empty and prototype-named fields in the fetch, Go, F#, Julia and Clojure snippets, and escape apostrophes in the PHP cURL body.
@scalar/use-codemirror@0.14.18
Patch Changes
- #10925: Stabilize the color-picker edit-position regression test by completing syntax parsing after document changes.
@scalar/astro@0.4.36
@scalar/express-api-reference@0.10.36
@scalar/fastify-api-reference@1.78.0
@scalar/hono-api-reference@0.12.19
@scalar/nestjs-api-reference@1.2.36
@scalar/nextjs-api-reference@0.12.17
@scalar/nuxt@0.6.89
@scalar/starlight@0.2.21
@scalar/sveltekit@0.3.36
@scalar/api-client-react@2.0.65
@scalar/api-reference-react@0.9.89
@scalar/asyncapi-upgrader@0.1.20
@scalar/asyncapi-validator@0.1.19
@scalar/client-side-rendering@0.4.18
@scalar/core@0.5.50
@scalar/import@0.5.36
@scalar/localization@0.2.11
@scalar/mermaid-plugin@0.1.6
@scalar/oas-utils@0.20.20
@scalar/object-utils@1.3.35
@scalar/openapi-parser@0.29.21
@scalar/openapi-validator@0.1.19
@scalar/postman-to-openapi@0.7.30
@scalar/pre-post-request-scripts@0.4.63
@scalar/server-side-rendering@0.1.68
@scalar/sidebar@0.12.8
@scalar/use-hooks@0.4.24
@scalar/void-server@2.5.21
@scalar/aspire@0.14.0
Bundled API Reference
- @scalar/api-reference@1.78.0
Minor Changes
- #10731: Support OpenID Connect flow defaults, including client ID, selected scopes, and PKCE, after discovery. Prefer a sole configured flow while retaining other discovered flows. Add typed OpenID Connect authentication configuration for .NET.
@scalar/aspnetcore@2.20.0
Bundled API Reference
- @scalar/api-reference@1.78.0
Minor Changes
- #10731: Support OpenID Connect flow defaults, including client ID, selected scopes, and PKCE, after discovery. Prefer a sole configured flow while retaining other discovered flows. Add typed OpenID Connect authentication configuration for .NET.
@scalar/aws-lambda@0.5.0
Bundled API Reference
- @scalar/api-reference@1.78.0
Minor Changes
- #10731: Support OpenID Connect flow defaults, including client ID, selected scopes, and PKCE, after discovery. Prefer a sole configured flow while retaining other discovered flows. Add typed OpenID Connect authentication configuration for .NET.
@scalar/azure-functions@0.5.0
Bundled API Reference
- @scalar/api-reference@1.78.0
Minor Changes
- #10731: Support OpenID Connect flow defaults, including client ID, selected scopes, and PKCE, after discovery. Prefer a sole configured flow while retaining other discovered flows. Add typed OpenID Connect authentication configuration for .NET.
@scalar/dotnet-shared@0.5.0
Minor Changes
- #10731: Support OpenID Connect flow defaults, including client ID, selected scopes, and PKCE, after discovery. Prefer a sole configured flow while retaining other discovered flows. Add typed OpenID Connect authentication configuration for .NET.
scalar-ninja@0.3.2
Patch Changes
- #10934: Keep embedded API descriptions inside the API reference configuration script and escape the Django Ninja page title.
scalar-fastapi@1.9.2
Patch Changes
- #10934: Keep embedded API descriptions inside the API reference configuration script and escape the Django Ninja page title.
galaxy-scalar-com@0.2.30
Patch Changes
- #10905: Configure a separate agent key for each Galaxy and Petstore API description.
scalar-app@1.1.48
Patch Changes
- #10903: Upgrade Monaco Editor and YAML support, migrate language APIs, and use Vite-managed workers in web and desktop editors.
@scalarapi/docker-api-reference@0.6.23
Bundled API Reference
- @scalar/api-reference@1.78.0
@scalar/java-integration@0.7.1
Bundled API Reference
- @scalar/api-reference@1.78.0
scalar_api_reference@0.2.23
Bundled API Reference
- @scalar/api-reference@1.78.0
@scalar/mock-server-docker@0.2.78
AI summary Added per-document authentication and request body reset
Releases
@scalar/api-client@3.24.0
Minor Changes
-
#10728: Add per-document authentication overrides merged with global defaults and an optional security scheme allowlist for the authentication UI.
-
#10729: Add a request body reset action that restores the original example, falling back to schema-generated values, without refreshing the page.
Expose
ObjectDoc.documentSourceas the base URI for resolving relative references in object documents. Add translation keys for restoring a body and creating an example from its schema.Resolved request body baselines are included in workspace exports but are not persisted in IndexedDB. After an IndexedDB reload or loading an older export, the first reset reconstructs the baseline from the original document, which may refetch external references and does not reapply configured overrides.
Patch Changes
- #10852: Show API responses for any HTTP status the server returns, including codes outside 200–599. Preserve network response statuses instead of passing them to the restricted
Responseconstructor. Keep streaming completion snapshots bodyless and cloneable so history does not consume or buffer the live stream. - #10732: Keep Paths extensions out of request-body snapshots, resets, default routing, and path parameter synchronization. Hide unselected Paths and Path Item extension sections in the classic layout.
- #10735: Reduce embedded hydration state, recover from damaged state, and preserve the client button during server rendering.
@scalar/api-reference@1.77.0
Minor Changes
- #10728: Add per-document authentication overrides merged with global defaults and an optional security scheme allowlist for the authentication UI.
- #10732: Render Paths Object and Path Item extensions alongside operation extensions within each operation in both layouts. Preserve arbitrary Paths Object extension values during browser loading and server preprocessing, and exclude them from operation navigation and tag/auth edits.
- #10662: Supply the plugin-aware specification extension renderer by default in API reference components while preserving custom renderer overrides. Export scrollTargetId from the helpers entry point for custom layouts.
- #10733: Render configured and plugin extensions on AsyncAPI channels, operations, messages, servers, and replies.
Patch Changes
- #10841: Fix the "Auth Required" badge panel briefly overflowing the viewport on hover by mounting the floating panel together with its content, so Floating UI positions it at its real width on first render.
- #10755: fix: add space below section dividers and between the last untagged operation and the next section in the classic layout
- #10733: Align AsyncAPI message and server extensions with their surrounding content and reduce excess spacing.
- #10734: Select an available server when a live API description update removes the previously selected server URL.
- #10805: fix: keep the page on the newest navigation target while an earlier target is still rendering
- #10771: Wrap operation titles without spaces, such as webhook names, on narrow screens instead of pushing the page wider than the viewport.
- #10732: Keep Paths extensions out of request-body snapshots, resets, default routing, and path parameter synchronization. Hide unselected Paths and Path Item extension sections in the classic layout.
- #10735: Preserve server-rendered API content during hydration by restoring the preloaded document state before the first browser render.
- #10869: Revert selected API description uploads in full mode until the backend supports them with agent-key authorization. Full mode uses the agent key's registered documents again.
- #10818: Open search much faster for API descriptions whose models reference each other by expanding each schema only once while building the search index. Preserve property descriptions through shared reference aliases and stop reading wide compositions at the traversal budget.
- #10820: Keep search responsive for API descriptions whose models reference each other by indexing schema fields up to 6 edges deep instead of 64. Fields nested more deeply no longer match their operations in search.
- #10819: Open search faster by reading each schema once per search index build, however many operations reference it.
- #10735: Reduce embedded hydration state, recover from damaged state, and preserve the client button during server rendering.
- #10771: Place request actions below the method and path in narrow fallback cards, keeping button labels readable without clipping.
- #10845: Prevent custom CSS and themes from closing style elements in generated HTML.
@scalar/helpers@0.17.0
Minor Changes
- #10862: Show post-response scripts, the agent and request history the response headers the API sent, instead of the values the Scalar proxy sets to protect its origin.
Patch Changes
- #10865: Show empty response headers under their own name, instead of the internal
X-Scalar-Original-*name the Scalar proxy uses. - #10845: Prevent custom CSS and themes from closing style elements in generated HTML.
@scalar/json-magic@0.18.0
Minor Changes
-
#10619: Add
bundleWithDiagnosticsto report reference failures with authored source locations, retain incomplete output, and defer pruning until resolution succeeds. Add opt-in document-aware traversal for OpenAPI, AsyncAPI, and JSON Schema, including literal data boundaries and applicable reference siblings. Preserve cached sources across diagnostic bundle calls.Use consistent URI fragment decoding across bundling and the magic proxy, and index newly exposed document fragments without revisiting unrelated subtrees.
Patch Changes
- #10786: Resolve
$refpointers with percent-encoded reserved characters, so#/paths/~1items%23listnow points at the/items#listpath instead of resolving to nothing. Preserve literal property names when resolving schema IDs and anchors, including keys containing/,~, or percent sequences.
@scalar/mock-server@0.21.0
Minor Changes
- #10809: feat: add an
onResponsehook to observe or replace the response for each request
Patch Changes
- #10808: fix: match concrete paths before templated ones, so
/pets/mineis answered by its own operation even when the document declares/pets/{petId}first - #10810: fix: leave an object document passed to
createMockServerunchanged instead of bundling it in place - #10812: fix(mock-server): include deprecated schemas in XML responses, so a response whose schema is deprecated no longer comes back with an empty XML body
@scalar/types@0.27.0
Minor Changes
- #10728: Add per-document authentication overrides merged with global defaults and an optional security scheme allowlist for the authentication UI.
Patch Changes
-
#10732: Render Paths Object and Path Item extensions alongside operation extensions within each operation in both layouts. Preserve arbitrary Paths Object extension values during browser loading and server preprocessing, and exclude them from operation navigation and tag/auth edits.
-
#10777: fix: allow
x-orderandx-scalar-ignoreon OAuth2 flows in theauthentication.securitySchemesconfiguration, so reordering or hiding flow tabs no longer causes a TypeScript error -
#10729: Add a request body reset action that restores the original example, falling back to schema-generated values, without refreshing the page.
Expose
ObjectDoc.documentSourceas the base URI for resolving relative references in object documents. Add translation keys for restoring a body and creating an example from its schema.Resolved request body baselines are included in workspace exports but are not persisted in IndexedDB. After an IndexedDB reload or loading an older export, the first reset reconstructs the baseline from the original document, which may refetch external references and does not reapply configured overrides.
@scalar/workspace-store@0.70.0
Minor Changes
-
#10729: Add a request body reset action that restores the original example, falling back to schema-generated values, without refreshing the page.
Expose
ObjectDoc.documentSourceas the base URI for resolving relative references in object documents. Add translation keys for restoring a body and creating an example from its schema.Resolved request body baselines are included in workspace exports but are not persisted in IndexedDB. After an IndexedDB reload or loading an older export, the first reset reconstructs the baseline from the original document, which may refetch external references and does not reapply configured overrides.
Patch Changes
-
#10730: Generate valid examples for known string formats in request bodies, including dates, times, durations, addresses, URIs, pointers, regular expressions, and version-specific UUIDs. Preserve existing password, binary, and unknown-format fallbacks.
Also generate formatted query and header values in code samples and querystring parameters. Versioned UUID formats (
uuid1–uuid8) now use matching version bits instead of the generic UUID, including in mock-server and response examples. Generate date/time values at request time so reused schemas stay current in long-lived tabs. -
#10732: Render Paths Object and Path Item extensions alongside operation extensions within each operation in both layouts. Preserve arbitrary Paths Object extension values during browser loading and server preprocessing, and exclude them from operation navigation and tag/auth edits.
-
#10862: Show post-response scripts, the agent and request history the response headers the API sent, instead of the values the Scalar proxy sets to protect its origin.
-
#10732: Keep Paths extensions out of request-body snapshots, resets, default routing, and path parameter synchronization. Hide unselected Paths and Path Item extension sections in the classic layout.
-
#10787: Resolve a relative document URL against the page before bundling, so external references in that document are fetched instead of being resolved to a root path that no loader handles.
-
#10804: perf: build with the TypeScript 7 native compiler
-
#10812: Keep deprecated schemas and properties in generated JSON and XML examples by default. Remove the
includeDeprecatedoption; deprecation no longer filters example values. Read/write and optional-property filtering still apply.
@scalar/nestjs-api-reference@1.2.35
Patch Changes
- #10837: Set the
text/htmlcontent type before sending the API reference, so the page renders with@nestjs/platform-node, whosesend()treats strings as plain text.
@scalar/nuxt@0.6.88
Patch Changes
- #10846: Explicitly type the Nuxt module export so dependency checks can trace its schema dependency before building.
@scalar/agent-chat@0.12.50
Patch Changes
- #10862: Show post-response scripts, the agent and request history the response headers the API sent, instead of the values the Scalar proxy sets to protect its origin.
- #10869: Revert selected API description uploads in full mode until the backend supports them with agent-key authorization. Full mode uses the agent key's registered documents again.
@scalar/blocks@0.6.4
Patch Changes
- #10733: Align AsyncAPI message and server extensions with their surrounding content and reduce excess spacing.
- #10814: fix(blocks): keep explicit badge colors above themed utility defaults
- #10771: Place request actions below the method and path in narrow fallback cards, keeping button labels readable without clipping.
- #10812: Keep deprecated schemas and properties in generated JSON and XML examples by default. Remove the
includeDeprecatedoption; deprecation no longer filters example values. Read/write and optional-property filtering still apply.
@scalar/client-side-rendering@0.4.17
Patch Changes
- #10845: Prevent custom CSS and themes from closing style elements in generated HTML.
@scalar/code-highlight@0.4.12
Patch Changes
- #10742: Restore the 1.4 default for highlighted code block containers after the highlighter migration, including plain text and blank lines, while allowing Markdown to retain its own spacing.
- #10849: Make code block containers own line spacing so highlighted text, plain text, blank lines, and line numbers use the same height. ScalarCodeBlock defaults to 1.4 and Markdown fenced code defaults to 1.5; override either with --scalar-code-line-height on the component or an ancestor. The shared highlighting stylesheet preserves the 1.4 default for direct consumers with a zero-specificity container rule, so existing container overrides still take precedence.
@scalar/components@0.33.2
Patch Changes
- #10735: Cancel the pending selected-option scroll when a combobox is unmounted.
- #10843: Prevent opening or navigating combobox options from scrolling the surrounding page before the picker is positioned.
- #10849: Make code block containers own line spacing so highlighted text, plain text, blank lines, and line numbers use the same height. ScalarCodeBlock defaults to 1.4 and Markdown fenced code defaults to 1.5; override either with --scalar-code-line-height on the component or an ancestor. The shared highlighting stylesheet preserves the 1.4 default for direct consumers with a zero-specificity container rule, so existing container overrides still take precedence.
@scalar/openapi-parser@0.29.20
Patch Changes
-
#10792: Reuse the JSON/YAML normalizer from
@scalar/json-magicso JSON documents with a leading UTF-8 BOM parse correctly. Malformed JSON arrays no longer fall back to YAML parsing.The exported
normalizefunction now uses the shared signature(content: unknown) => unknown; callers must narrow the parsed result before accessing its properties.
@scalar/pre-post-request-scripts@0.4.62
Patch Changes
- #10862: Show post-response scripts, the agent and request history the response headers the API sent, instead of the values the Scalar proxy sets to protect its origin.
@scalar/server-side-rendering@0.1.67
Patch Changes
- #10845: Prevent custom CSS and themes from closing style elements in generated HTML.
@scalar/snippetz@0.10.15
Patch Changes
-
#10823: Send cookies with the Cookie request header in Node fetch, ofetch, and undici snippets, merge existing cookie headers in Node and axios snippets, and use the browser cookie store in JavaScript fetch, ofetch, and axios snippets.
Preserve both explicit Cookie headers and structured cookies across the other HTTP header-based generators, including curl, wget, Ruby, Go, Swift, Objective-C, Rust, Dart, Clojure, R, Kotlin, C#, PHP cURL, Python http.client, and C libcurl. Include structured cookies in raw HTTP examples.
Explain cookie header entries without
=in browser snippets instead of silently dropping them. -
#10838: Generate valid Python literals for boolean JSON request bodies in Requests, HTTPX, and aiohttp snippets.
-
#10838: Preserve root JSON scalars in browser Fetch, Node Fetch, Undici, clj-http, and Objective-C NSURLSession code examples instead of converting booleans to objects, omitting false bodies, or rejecting JSON fragments.
@scalar/use-codemirror@0.14.17
Patch Changes
- #10824: Maintain the CSS color picker locally and declare its Lezer dependency so imports work with strict package-manager layouts.
- #10734: Refresh color swatches when background parsing updates the syntax tree.
@scalar/astro@0.4.35
@scalar/docusaurus@0.8.56
@scalar/express-api-reference@0.10.35
@scalar/fastify-api-reference@1.77.0
@scalar/hono-api-reference@0.12.18
@scalar/nextjs-api-reference@0.12.16
@scalar/starlight@0.2.20
@scalar/sveltekit@0.3.35
@scalar/api-client-react@2.0.64
@scalar/api-reference-react@0.9.88
@scalar/asyncapi-to-markdown@0.2.6
@scalar/asyncapi-upgrader@0.1.19
@scalar/asyncapi-validator@0.1.18
@scalar/core@0.5.49
@scalar/import@0.5.35
@scalar/json-schema-validator@0.1.18
@scalar/localization@0.2.10
@scalar/mermaid-plugin@0.1.5
@scalar/nextjs-openapi@0.3.56
@scalar/oas-utils@0.20.19
@scalar/object-utils@1.3.34
@scalar/openapi-to-markdown@1.7.4
@scalar/openapi-upgrader@0.4.7
@scalar/openapi-validator@0.1.18
@scalar/postman-to-openapi@0.7.29
@scalar/release-notes@0.2.10
@scalar/schemas@0.16.1
@scalar/sidebar@0.12.7
@scalar/use-hooks@0.4.23
@scalar/void-server@2.5.20
@scalar/aspire@0.13.0
Bundled API Reference
- @scalar/api-reference@1.77.0
Minor Changes
- #10728: Add per-document authentication overrides merged with global defaults and an optional security scheme allowlist for the authentication UI.
@scalar/aspnetcore@2.19.0
Bundled API Reference
- @scalar/api-reference@1.77.0
Minor Changes
- #10728: Add per-document authentication overrides merged with global defaults and an optional security scheme allowlist for the authentication UI.
@scalar/aws-lambda@0.4.0
Bundled API Reference
- @scalar/api-reference@1.77.0
Minor Changes
- #10728: Add per-document authentication overrides merged with global defaults and an optional security scheme allowlist for the authentication UI.
@scalar/azure-functions@0.4.0
Bundled API Reference
- @scalar/api-reference@1.77.0
Minor Changes
- #10728: Add per-document authentication overrides merged with global defaults and an optional security scheme allowlist for the authentication UI.
@scalar/dotnet-shared@0.4.0
Minor Changes
- #10728: Add per-document authentication overrides merged with global defaults and an optional security scheme allowlist for the authentication UI.
@scalar/java-integration@0.7.0
Bundled API Reference
- @scalar/api-reference@1.77.0
Minor Changes
-
#10825: Expose additional UI, code sample, OAuth redirect, and service URL configuration in the Java integrations.
-
#10825: Support inline API descriptions, document titles and slugs, and grouped authentication preferences in the Java integrations.
Escape HTML page titles and preserve configured source URLs while applying inline-content precedence during rendering.
-
#10821: Add Spring Boot localization options for locale, text direction, and custom UI translations in WebMVC and WebFlux.
-
#10827: Support path-based API Reference navigation and deep-link reloads in Spring WebMVC and WebFlux.
@scalar/mock-server-docker@0.2.77
Patch Changes
- #10811: feat(mock-server): allow disabling request validation in the Docker image with the
--no-validate-requestflag or theVALIDATE_REQUEST=falseenvironment variable, so requests that violate the API description get a mock response instead of a422
@scalarapi/docker-api-reference@0.6.22
Bundled API Reference
- @scalar/api-reference@1.77.0
scalar_api_reference@0.2.22
Bundled API Reference
- @scalar/api-reference@1.77.0
scalar-app@1.1.47
AI summary Added server framework to hosting waitlist sign-ups
Releases
@scalar/api-reference@1.76.4
Patch Changes
- #10796: feat: send the server framework with hosting waitlist sign-ups
@scalar/fastify-api-reference@1.76.4
@scalar/nuxt@0.6.87
@scalar/api-reference-react@0.9.87
@scalar/server-side-rendering@0.1.66
@scalarapi/docker-api-reference@0.6.21
Bundled API Reference
- @scalar/api-reference@1.76.4
@scalar/aspire@0.12.7
Bundled API Reference
- @scalar/api-reference@1.76.4
@scalar/aspnetcore@2.18.7
Bundled API Reference
- @scalar/api-reference@1.76.4
@scalar/aws-lambda@0.3.7
Bundled API Reference
- @scalar/api-reference@1.76.4
@scalar/azure-functions@0.3.7
Bundled API Reference
- @scalar/api-reference@1.76.4
@scalar/java-integration@0.6.87
Bundled API Reference
- @scalar/api-reference@1.76.4
scalar_api_reference@0.2.21
Bundled API Reference
- @scalar/api-reference@1.76.4
@ Every self-hosted release, weekly
One Monday email with the week's stable releases across the directory.
FAQ
Can I write tests for API responses?
Yes, post-response scripts can assert on status codes, headers and bodies with the Postman-compatible pm API.
Does the API Client work offline?
Yes, it is offline-first: requests and collections live on your machine, and the desktop app only needs a network for the requests you send.
Can I import an OpenAPI or Swagger file?
OpenAPI 3.x in JSON or YAML is the native format; Swagger 2.0 is upgraded to OpenAPI 3.1, and URL, Postman collection or cURL imports also work.
Which platforms does the API Client run on?
The browser, plus desktop apps for macOS, Windows and Linux.
Is Scalar a Postman alternative?
For many teams it is: requests, collections, environments, scripts and response tests are covered, and Postman v2.0/v2.1 collections can be imported, but collections are built from your OpenAPI document.
Is Scalar API Client free?
Yes, it is MIT-licensed open source and free in the browser at client.scalar.com or as a desktop app.
More in API
SeekStormOpen-source Rust search engine with BM25 lexical and vector search fused in one hybrid query, multi-tenant REST server, web UI and MCP support. Self-hosted, free forever.
Signal-APISelf-hosted, open-source Docker container that wraps signal-cli as a REST API, so scripts can register a Signal number and send, receive and manage messages.
storStor is a self-hosted, open-source JSON database that exposes a REST-like HTTP API for CRUD operations, using MongoDB as its storage backend and Node.js for the server.
SupabaseMetaOpen-source, self-hosted REST API that manages Postgres over HTTP: list and alter tables, columns, roles, functions and triggers, run SQL, generate types.
tabbyAPITabbyAPI is a self-hosted, open-source FastAPI server providing an OpenAI-compatible REST API for running ExllamaV3-quantized LLMs on your own GPU hardware.
tempmail-serverSelf-hosted disposable email backend with SMTP server and REST API. Features auto-expiring addresses, multi-domain support, and PostgreSQL storage.
teslamateapiTeslaMateApi is a self-hosted, open-source REST API exposing TeslaMate vehicle data as JSON with endpoints for status, drives, charges, and remote commands.
TrailBaseOpen-source, self-hosted Firebase alternative: one Rust executable with SQLite, type-safe REST and realtime APIs, auth, file storage, WASM endpoints and an admin UI.
TurtlOpen-source, self-hosted backend server for Turtl clients: account management, data storage, syncing, sharing permissions and a plugin architecture, on Node and Postgres.
unbagrndUnbagrnd - Free, Fast & Open-source AI-powered background remover for Windows, macOS, Linux and Android.
UniFi-API-BrowserSelf-hosted, open-source PHP tool to browse UniFi Controller API data: multiple classic or API-key controllers, site switching, JSON/PHP output.
unstructuredSelf-hosted open-source REST API for document partitioning into structured elements as JSON/CSV. Supports PDF, images, OCR, table extraction, chunking.
0 comments