└ Renders OpenAPI/Swagger documents
└ Comes with an API testing tool
└ Doesn't look like 2011
└ Generates code examples for many languages & frameworks
└ Integrates with your favorite framework
└ Try Demo
└ Free and open-source
└ First-class OpenAPI/Swagger support
└ Integrates with dozens of API Frameworks (Elysia, Hono, FastAPI, etc)
└ Syncs with your favorite server framework (Watch Mode)
└ Has environment variables, dynamic parameters and everything
└ Try It in the Browser
└ Download (Windows, MacOS, Linux)
All you need is a single HTML file to create an amazing 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>
<div id="app"></div>
<!-- Load the Script -->
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
<!-- Initialize the Scalar API Reference -->
<script>
Scalar.createApiReference('#app', {
// The URL of the OpenAPI/Swagger document
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
// Avoid CORS issues
proxyUrl: 'https://proxy.scalar.com',
})
</script>
</body>
</html>Need a Custom Header? Check out this example: https://codepen.io/scalarorg/pen/VwOXqam
And there's an ever-growing list of plugins and integrations:
- HTML/JS API (works everywhere)
- .NET ASP.NET Core
- .NET Aspire
- AdonisJS
- Astro
- Django Ninja
- Django
- Docker
- Docusaurus
- Elixir
- Express
- FastAPI
- Fastify
- Flask
- Go
- Hapi
- Hono
- Laravel Scribe
- Laravel
- Micronaut
- NestJS
- Next.js
- Nuxt
- Python
- React
- Ruby on Rails
- Rust
- Spring Boot
- SvelteKit
- 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 API references (free)
YOUR_NAME_HERE.apidocumentation.comsubdomain and SSL (free)- GitHub Sync
- Write free-form documentation
- Collaborate with your team
- Use any domain
Ready? Create your Scalar Account
| Topic | Description |
|---|---|
| Configuration | The universal configuration object |
| Themes | Predefined themes, layouts & styling |
| OpenAPI | OpenAPI specification extensions |
| Markdown | Supported Markdown syntax |
| Plugins | Extend the functionality |
| Project | Description |
|---|---|
| Scalar API Reference | Self-hosted API Reference |
| Scalar API Client | Postman alternative |
| Agent Scalar | Chat with your API |
| Scalar Registry | Manage OpenAPI documents |
| Scalar Docs | Hosted documentation |
| Scalar Docs Starter | Starter template for Scalar Docs |
| Scalar SDKs | SDK generation |
| Scalar CLI | Command-line interface |
| Scalar Mock Server | Mock APIs from OpenAPI documents |
| Scalar Galaxy | Our OpenAPI Example |
| Scalar Editor | OpenAPI Online Editor |
| Scalar OpenAPI Parser | Parse OpenAPI documents |
| Scalar OpenAPI to Markdown | OpenAPI > Markdown/HTML |
| Scalar OpenAPI Upgrader | Upgrade OpenAPI documents |
| Scalar Void Server | HTTP Request Mirror |
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 (April 2025)
Top Contributors (All Time)
![@github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=64&v=4){kind=small}
![@renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=64&v=4){kind=small}
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
