Scalar
Interactive API Reference from OpenAPI/Swagger
└ 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
An offline-first API Client built for OpenAPI
└ 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)
Trusted by:
Quickstart
Set up with your coding agent
Copy this prompt into your coding agent from your project:
Set up Scalar API Reference in this project.
Inspect the project’s framework, package manager, routing, and existing
OpenAPI setup. Choose the appropriate framework integration from
https://scalar.com/products/api-references and install it using this
project’s conventions.
If no framework integration exists, render a route using the HTML/JS guide:
https://scalar.com/products/api-references/integrations/html-js
Also ask whether I want to request a framework integration here:
https://github.com/scalar/scalar/discussions/new?category=ideas
Serve the API reference at /scalar, or use an existing documentation route,
and connect it to the project’s OpenAPI document or generated endpoint.
If no OpenAPI document exists, ask me which source to use or whether
we need to add OpenAPI generation.
Use these guides for configuration and theming:
https://scalar.com/products/api-references/configuration
https://scalar.com/products/api-references/themes
Implement the setup, verify that the page loads and displays the API
documentation, and tell me how to run it locally and where to find it.
Set up with HTML
All you need is a single HTML file. Load the ESM build from our CDN, with no build step required:
<!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>
<script type="module">
import { createApiReference } from 'https://cdn.jsdelivr.net/npm/@scalar/api-reference/esm.js'
createApiReference('#app', {
// The URL of the OpenAPI 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:
Integrations
- HTML/JS API (works everywhere)
- .NET ASP.NET Core
- Aspire
- AdonisJS
- Astro
- Django Ninja
- Django
- Docker
- Docusaurus
- Elixir
- Express
- FastAPI
- Fastify
- Flask
- Go
- Hapi
- Hono
- Java
- Laravel Scribe
- Laravel
- Micronaut
- NestJS
- Next.js
- Nuxt
- Python
- React
- Ruby on Rails
- Rust
- Spring Boot
- SvelteKit
- Symfony
- Ts.ED
- Vue.js
Built-in Support
The following frameworks have chosen Scalar API Reference as their default OpenAPI documentation UI, recognizing its developer-friendly features and modern design:
Managed Hosting
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
Documentation
| Topic | Description | | ------------------------------------------------------------------------- | ------------------------------------ | | Configuration | The universal configuration object | | Themes | Predefined themes, layouts & styling | | OpenAPI | OpenAPI specification extensions | | Markdown | Supported Markdown syntax | | Plugins | Extend the functionality |
Projects
| 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 |
Community
We are API nerds. You too? Let's chat on Discord:
Contributions
Contributions are welcome! Read the CONTRIBUTING guide.
Top Contributors (Last Month)
Top Contributors (All Time)
