Scalar
Modern, beautiful API reference documentation renderer and API client built on OpenAPI specs. Scalar provides a polished, interactive API documentation UI that replaces Swagger UI with a much better UX — includes an integrated API playground (client), dark mode, search, and modern design. Available as a free hosted service, embeddable React/Vue component, and integrations for major frameworks (FastAPI, Express, Hono, Rails, Laravel). The open-source answer to Readme.com and Redocly.
Score Breakdown
⚙ Agent Friendliness
🔒 Security
API playground executes requests from user's browser — no proxy, credentials stay client-side. Hosted service stores specs — privacy review needed for sensitive API docs. MIT licensed.
⚡ Reliability
Best When
You have an OpenAPI spec and want a beautiful, interactive API reference UI with zero cost — Scalar is better than Swagger UI and free at scale.
Avoid When
You need a full developer portal with guides, changelogs, and user management — use Readme.com or Redocly Developer Portal.
Use Cases
- • Render beautiful, interactive API documentation from OpenAPI specs as a replacement for basic Swagger UI with better UX
- • Embed API reference documentation directly in documentation sites using Scalar's React, Vue, or vanilla JS components
- • Host public API documentation on scalar.com for free with a custom domain for developer-facing API products
- • Add interactive API playground to API documentation using Scalar's built-in HTTP client that executes requests directly in the browser
- • Integrate API documentation into framework-specific apps (FastAPI auto-generates Scalar docs, Hono has official Scalar plugin)
Not For
- • Full developer portal with guides and tutorials — Scalar is API reference-focused; use Redocly or Readme.com for full portals
- • Non-OpenAPI APIs — Scalar requires OpenAPI 2.0/3.x specs
- • Server-side API generation — Scalar renders specs, it does not generate SDKs
Interface
Authentication
Open source components require no auth. Scalar.com hosted service has a free tier with optional account. The API playground in Scalar passes credentials from the user's browser directly to the target API.
Pricing
Core @scalar/api-reference package is MIT open source. Scalar.com is the managed hosting service with free and paid tiers. Self-hosting the component is completely free.
Agent Metadata
Known Gotchas
- ⚠ Scalar requires a valid OpenAPI 3.x spec — OpenAPI 2.0 (Swagger) is supported but with feature limitations; some 2.0-specific features may not render correctly
- ⚠ The Scalar API playground sends requests directly from the browser — CORS must be configured on the target API to allow requests from the Scalar domain
- ⚠ Scalar.com hosted service stores the OpenAPI spec on their servers — avoid uploading specs containing internal URLs, PII examples, or sensitive schema details
- ⚠ Large OpenAPI specs (10MB+) may cause rendering performance issues in the browser — consider filtering or splitting specs before hosting
- ⚠ Framework integrations (FastAPI, Hono) auto-generate Scalar routes — verify the generated spec URL is correct as it differs by framework
- ⚠ The @scalar/api-reference component requires a bundler (Vite, webpack) for integration — vanilla script tag CDN usage is available but less flexible for customization
Alternatives
Full Evaluation Report
Detailed scoring breakdown, competitive positioning, security analysis, and improvement recommendations for Scalar.
Scores are editorial opinions as of 2026-03-06.