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 &…
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
<!-- minimal line break-->
<!-- end minimal line break-->
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)
<!-- minimal line break-->
<!-- end minimal line break-->
Trusted by:
Quickstart
All you need is a single HTML file to create an amazing API reference:
html
<!doctype html>
Scalar API Reference
<!-- Load the Script -->
<!-- Initialize the Scalar API Reference -->
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',
})> 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
- Laravel Scribe
- Laravel
- Micronaut
- NestJS
- Next.js
- Nuxt
- Python
- React
- Ruby on Rails
- Rust
- Spring Boot
- SvelteKit
- 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](packages/galaxy/README.md) | Our OpenAPI Example |
| Scalar Editor | OpenAPI Online Editor |
| [Scalar OpenAPI Parser](packages/openapi-parser/README.md) | Parse OpenAPI documents |
| [Scalar OpenAPI to Markdown](packages/openapi-to-markdown/README.md) | OpenAPI > Markdown/HTML |
| [Scalar OpenAPI Upgrader](packages/openapi-upgrader/README.md) | Upgrade OpenAPI documents |
| [Scalar Void Server](packages/void-server/README.md) | HTTP Request Mirror |
Community
We are API nerds. You too? Let's chat on Discord:
Contributions
Contributions are welcome! Read the [CONTRIBUTING](CONTRIBUTING.md) guide.
Top 10 Contributors (April 2025)
Top Contributors (All Time)
<!-- readme: collaborators,contributors -start -->
hanspagel
xC0dex
amritk
antlio
hwkr
marclave
DemonHa
cameronrohani
geoffgscott
…
Members
-
scalar ★ PINNED
Scalar is an open-source API platform: 🌐 Modern REST API Client 📖 Beautiful API References ✨ 1st-Class OpenAPI/Swagger Support
TypeScript ★ 16k 1d agoExplain → -
laravel
Scalar OpenAPI References in Laravel
PHP ★ 67 22d agoExplain → -
openapi-parser ▣
Modern OpenAPI parser written in TypeScript
TypeScript ★ 39 1y agoExplain → -
sandbox
The easiest way to share OpenAPI files
Vue ★ 25 5d agoExplain → -
sdk-generator
Best-in-class SDKs generated from OpenAPI, in your favorite languages
★ 18 22d agoExplain → -
starter
Scalar Docs Starter Kit
★ 11 1mo agoExplain → -
cli ▣
Command-line interface to work with OpenAPI files
TypeScript ★ 10 1y agoExplain → -
snippetz ▣
Opinionated HTTP snippets 🌐
TypeScript ★ 10 1y agoExplain → -
mock-server-playground
Scalar Mock Server Playground
TypeScript ★ 4 7mo agoExplain → -
scalar-node
TypeScript SDK for the Scalar API
TypeScript ★ 3 3d agoExplain → -
typebox ⑂
Json Schema Type Builder with Static Type Resolution for TypeScript
TypeScript ★ 3 6mo agoExplain → -
scalar-rust
No description.
★ 1 3d agoExplain → -
scalar-bot
Our Discord bot for https://discord.gg/scalar
Python ★ 1 1y agoExplain → -
scalar-cli
No description.
★ 0 3d agoExplain → -
galaxy-node-sdk
No description.
TypeScript ★ 0 20d agoExplain → -
galaxy-go-sdk
No description.
Go ★ 0 20d agoExplain → -
galaxy-rust-sdk
No description.
★ 0 20d agoExplain → -
galaxy-python-sdk
No description.
★ 0 20d agoExplain → -
scalar-python
No description.
★ 0 3d agoExplain → -
scalar-go
No description.
★ 0 3d agoExplain →
No repos match these filters.