Scalar

 	</a>

	</a>
</p>

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

Install the scalar-api-reference skill to give your coding agent guidance for framework integration, configuration, and troubleshooting:

npx skills add scalar/scalar --skill scalar-api-reference

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:

• Effect
• ElysiaJS
• HappyX
• Litestar
• Nitro
• oRPC
• Platformatic
• Spry

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.com subdomain and SSL (free)
• GitHub Sync
• Write free-form documentation
• Collaborate with your team
• Use any domain

Ready? Create your Scalar Account

Documentation

Projects

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)

hanspagel	amritk	hwkr	marclave	DemonHa	cameronrohani
xC0dex	geoffgscott	marcalexiei	tmastrom	antlio	inyourtime
liamdscalar	bgrcs	lazerg	bielu	AbdelhamidKhald	gevann
charan-rathore	alonfaraj	AshishKumarPathak	federicobond	ahmedrangel	matthyk
Amorim33	wilhelmer	baywet	YagUber	Mason-Little	ivanagas
Edgaraszs	guillaume-flambard	adjsky	RemcoGoy	mcollina	mpminardi
TheVaan	cobyfrombrooklyn-bot	si-net	paulomorgado	ATREAY	fuma-nama
AdzerKI	lc-soft	Mohib834	nsychev	yshrsmz	hex0id
soulchild	trusta	jpjpjp	horpto	x-delfino	ykdojo
wilcoschoneveld	timheuer	ledgersteve	SimonVadier	SebastianBienert	WDaan
Duncanma	aqeelat	silkfire	gsmcdonald	handrews	cyphercodes
PrinceManfred	mouhannad-sh	mason-at-pieces	luc122c	luke-hagar-sp	kou029w
robert-dean	bobheadxi	rcollas	rbange	hrynevychroman	rpmccarter
roryschadler	rmp135	ryux1	mirismaili	STP5940	captainsafia
realsama	ventocis	SamyPesse	scottamain	SergioChan	medz
dotfortun	smoores-dev	soGit	MarioGK	not-my-profile	tinchoz49
MatteoH2O1999	maxehmookau	MaxBreida	mvt147	theluckystrike	michielbdejong
1571min	fitchmultz	malinbranduse	Lazialize	Olexandr88	pat-s
pkucmus	petercinibulk	petvas	philsturgeon	pdjohntony	Fjandin
rhuanbarreto	rickihastings	Chinlinlee	bsdayo	WilliamBonvini	danwithabox
demingongo	eightdeekay	FotieMConstant	ga1az	g-airey	gary5
kwaichanz	lavagri	milksense	o-az	omerp-explorium	stefanprobst
dunklesToast	tsiwek-piwik	dinwwwh	zgcalebp	Huliiiiii	sidsri14
sinh117801	smrtfl	stratosblue	taljeon	yokeTH	Thiago-Mausbach
thibaultleouay	thijskok	TomzBench	rektdeckard	Courtcircuits	ubay1
mveselov-stack-wizard	Mai0313	Ma-ve	WesleySkeen	rotciw	Wolf-Syndrome
rolldeep-stepmerrily	zakaria-shahen	bingbeann	cactyx	foxfriends	carstenlebek
chadwhitacre	chrislearn	jensenbox	ClanEver	damiansan239	danjohnson95
danp	benedekdaniel	darekaze	DavidNiessen	delputnam	lundibundi
untiny	diegolopes	DmitriiKhudiakov	Garfielk	elliotnash	elliott-with-the-longest-name-on-github
emmanuel-ferdman	IsaacJenkinsTPZ	abdulamite	MathurAditya724	ahmadi-akbar	slash686
alewin	Anandb71	gizero	sigpwned	vixalien	AniketR10
arashsheyda	thisisarko	arthurfiorette	zsilbi	saithis	BenJeau
bdpiprava	Borisich	xmrfate	bmanth60	brianheineman	brunogrcsada
Smyrcu	andthexi	JacobCoffee	jan-krueger	Tholdrim	Jefwillems
jqwn	Jannchie	Joab0	jonataw	IHIutch	JosiahParry
Gulum	jlnslv	kaigritun	KevSlashNull	krcm0209	kyllian
sanscontext	ShadiestGoat	momomuchu	da411d	marikaner	froggy1014
facus26	filiabel	flovouin	Fdawgs	fredrik-aschehoug	galah92
GavinPizza	ff-gerard	GreyXor	255kb	gurkanceylan41	haidargit
Hamidrzash	haydenbleasel	HelgeSverre	CJHwong	hpmouton	iagobalmeida
IceyWu	Poliklot	eltociear	tltsutltsu