Scalar

Beautiful API references from Swagger/OpenAPI file
GitHub
7.98k
Created a year ago, last commit 11 hours ago
98 contributors
3.63k commits
Stars added on GitHub, month by month
N/A
N/A
N/A
12
1
2
3
4
5
6
7
8
9
10
11
2023
2024
Stars added on GitHub, per day, on average
Yesterday
+7
Last week
+15.0
/day
Last month
+17.1
/day
npmPackage on NPM
Monthly downloads on NPM
12
1
2
3
4
5
6
7
8
9
10
11
2023
2024
README

CI Contributors GitHub License Discord Scalar App

Scalar

Scalar API client Scalar API Reference

An offline first API Client built for OpenAPI

└ 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

Interactive API Reference from OpenAPI/Swagger

└ Uses OpenAPI/Swagger documents
└ 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

Trusted by:


Quickstart

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:

Integrations

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 your API references (free)
  • Get SSL and a super cool *.apidocumentation.com subdomain (free)
  • Write free text documentation (paid)
  • Collaborate with your whole team (paid)
  • Use any domain (paid)

Ready? Create your account on scalar.com.


Projects

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

Documentation

Topic Description
Themes Themes, layouts & styling
Configuration The universal configuration object
OpenAPI OpenAPI and our extensions to it
Markdown Markdown syntax

Community

We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar


Contributions

Contributions are welcome! Read the CONTRIBUTING guide.

Top 10 Contributors (November 2024)



Top Contributors (All Time)

hanspagel
hanspagel
amritk
amritk
xC0dex
xC0dex
tmastrom
tmastrom
marclave
marclave
antlio
antlio
hwkr
hwkr
cameronrohani
cameronrohani
geoffgscott
geoffgscott
inyourtime
inyourtime
Amorim33
Amorim33
Mason-Little
Mason-Little
adjsky
adjsky
ATREAY
ATREAY
Edgaraszs
Edgaraszs
lc-soft
lc-soft
Mohib834
Mohib834
mcollina
mcollina
mpminardi
mpminardi
soulchild
soulchild
yshrsmz
yshrsmz
hex0id
hex0id
x-delfino
x-delfino
ykdojo
ykdojo
timheuer
timheuer
mouhannad-sh
mouhannad-sh
mason-at-pieces
mason-at-pieces
fuma-nama
fuma-nama
federicobond
federicobond
gsmcdonald
gsmcdonald
dotfortun
dotfortun
SebastianBienert
SebastianBienert
realsama
realsama
captainsafia
captainsafia
STP5940
STP5940
rmp135
rmp135
rpmccarter
rpmccarter
hrynevychroman
hrynevychroman
rbange
rbange
rickihastings
rickihastings
MaxBreida
MaxBreida
MarioGK
MarioGK
ShadiestGoat
ShadiestGoat
sanscontext
sanscontext
kyllian
kyllian
soGit
soGit
sinh117801
sinh117801
thibaultleouay
thibaultleouay
Courtcircuits
Courtcircuits
Mai0313
Mai0313
wilcoschoneveld
wilcoschoneveld
ruizhii
ruizhii
Chinlinlee
Chinlinlee
bsdayo
bsdayo
WilliamBonvini
WilliamBonvini
danwithabox
danwithabox
FotieMConstant
FotieMConstant
ga1az
ga1az
dunklesToast
dunklesToast
tsiwek-piwik
tsiwek-piwik
Huliiiiii
Huliiiiii
diegolopes
diegolopes
lundibundi
lundibundi
darekaze
darekaze
danp
danp
danjohnson95
danjohnson95
chrislearn
chrislearn
chadwhitacre
chadwhitacre
carstenlebek
carstenlebek
brunogrcsada
brunogrcsada
bdpiprava
bdpiprava
zsilbi
zsilbi
arthurfiorette
arthurfiorette
arashsheyda
arashsheyda
sigpwned
sigpwned
alewin
alewin
slash686
slash686
abdulamite
abdulamite
KiARC
KiARC
IHIutch
IHIutch
jonataw
jonataw
Jefwillems
Jefwillems
TheVaan
TheVaan
JacobCoffee
JacobCoffee
kevinand11
kevinand11
eltociear
eltociear
IceyWu
IceyWu
ivanagas
ivanagas
CJHwong
CJHwong
HelgeSverre
HelgeSverre
GreyXor
GreyXor
Fdawgs
Fdawgs
facus26
facus26
emmanuel-ferdman
emmanuel-ferdman
elliotnash
elliotnash