â”” Minimal, powerful & open-source
â”” Integrates with dozens of API Frameworks (Elysia, Hono, FastAPI, etc)
â”” Syncs directly with your server frameworks with our Watch Mode
â”” First class OpenAPI (formerly Swagger) support
â”” Environment variables and dynamic parameters
â”” Save and organize requests into collections
â”” Download (Windows, MacOS, Linux)
â”” Try Online Demo
â”” Request examples for many favorite languages and frameworks
â”” Comes with an integrated API playground
â”” Integrates with your favorite framework
â”” Doesn't look like 2011
â”” Try Demo
You’re just one HTML file away from having an awesome API reference:
<!doctype html>
<html>
<head>
<title>Scalar API Reference</title>
<meta charset="utf-8" />
<meta
name="viewport"
content="width=device-width, initial-scale=1" />
</head>
<body>
<!-- Need a Custom Header? Check out this example: https://codepen.io/scalarorg/pen/VwOXqam -->
<!-- Note: We’re using our public proxy to avoid CORS issues. You can remove the `data-proxy-url` attribute if you don’t need it. -->
<script
id="api-reference"
data-url="https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml"
data-proxy-url="https://proxy.scalar.com"></script>
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
</body>
</html>And there’s an ever-growing list of plugins and integrations:
- HTML (works everywhere)
- .NET
- AdonisJS
- Django Ninja
- Docusaurus
- Express
- FastAPI
- Fastify
- Go
- Hono
- Laravel Scribe
- NestJS
- Next.js
- Nuxt
- React
- Ruby on Rails
- Rust
- Scalar for Laravel
- Ts.ED
- Vue.js
The following frameworks have chosen Scalar API Reference as their default OpenAPI documentation UI, recognizing its developer-friendly features and modern design:
We’re offering a free and paid managed hosting on the edge, too:
- Write your API documentation and publish your API references (free)
- Get SSL and a super cool
*.apidocumentation.comsubdomain (free) - Write free text documentation (paid)
- Collaborate with your whole team (paid)
- Use any domain (paid)
Ready? Create your account on scalar.com.
| Project | Description |
|---|---|
| Scalar API Client | API client |
| Scalar CLI | Command-line interface |
| Scalar Galaxy | OpenAPI Example |
| Scalar Play Button | Quick API Client Embed |
| Scalar Mock Server | OpenAPI Mock Server |
| Scalar Void Server | HTTP Request Mirror |
| Scalar Open API Parser | OpenAPI SDK |
| Scalar Sandbox | Online OpenAPI Editor |
| Topic | Description |
|---|---|
| Themes | Themes, layouts & styling |
| Configuration | The universal configuration object |
| OpenAPI | OpenAPI and our extensions to it |
| Markdown | Markdown syntax |
We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar
Contributions are welcome! Read the CONTRIBUTING guide.
Top 10 Contributors (November 2024)
Top Contributors (All Time)
