Scalar

Beautiful API references from Swagger/OpenAPI file
GitHub
6.41k
Created a year ago, last commit 16 hours ago
80 contributors
3.1k commits
Stars added on GitHub, month by month
N/A
N/A
N/A
N/A
N/A
10
11
12
1
2
3
4
5
6
7
8
9
2023
2024
Stars added on GitHub, per day, on average
Yesterday
+13
Last week
+17.0
/day
Last month
+23.2
/day
Package on NPM
Monthly downloads on NPM
10
11
12
1
2
3
4
5
6
7
8
9
2023
2024
README

CI Contributors GitHub License Discord

Scalar

Scalar API client Scalar API Reference

An offline first API Client built for OpenAPI

Download    Try Demo

Interactive API Reference from OpenAPI/Swagger

Try Demo   

Trusted by:



Features

  • Uses OpenAPI/Swagger documents
  • Request examples for many favorite languages and frameworks
  • Comes with an integrated API client
  • Integrates with your favorite framework
  • Doesn’t look like it’s 2011

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 -->
    <script
      id="api-reference"
      data-url="https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml"></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


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 (September 2024)



Top Contributors (All Time)

hanspagel
hanspagel
amritk
amritk
xC0dex
xC0dex
tmastrom
tmastrom
marclave
marclave
hwkr
hwkr
antlio
antlio
cameronrohani
cameronrohani
geoffgscott
geoffgscott
inyourtime
inyourtime
Amorim33
Amorim33
adjsky
adjsky
ATREAY
ATREAY
Edgaraszs
Edgaraszs
Mohib834
Mohib834
mcollina
mcollina
soulchild
soulchild
mpminardi
mpminardi
hex0id
hex0id
x-delfino
x-delfino
ykdojo
ykdojo
timheuer
timheuer
mouhannad-sh
mouhannad-sh
mason-at-pieces
mason-at-pieces
Mason-Little
Mason-Little
gsmcdonald
gsmcdonald
federicobond
federicobond
SebastianBienert
SebastianBienert
realsama
realsama
captainsafia
captainsafia
STP5940
STP5940
hrynevychroman
hrynevychroman
rbange
rbange
rickihastings
rickihastings
MaxBreida
MaxBreida
MarioGK
MarioGK
ShadiestGoat
ShadiestGoat
kyllian
kyllian
KiARC
KiARC
dotfortun
dotfortun
soGit
soGit
sinh117801
sinh117801
thibaultleouay
thibaultleouay
yshrsmz
yshrsmz
bitlab-ruizhi
bitlab-ruizhi
Chinlinlee
Chinlinlee
WilliamBonvini
WilliamBonvini
danwithabox
danwithabox
FotieMConstant
FotieMConstant
dunklesToast
dunklesToast
tsiwek-piwik
tsiwek-piwik
alewin
alewin
sigpwned
sigpwned
arashsheyda
arashsheyda
arthurfiorette
arthurfiorette
zsilbi
zsilbi
bdpiprava
bdpiprava
brunogrcsada
brunogrcsada
carstenlebek
carstenlebek
chadwhitacre
chadwhitacre
chrislearn
chrislearn
danp
danp
darekaze
darekaze
lundibundi
lundibundi
diegolopes
diegolopes
emmanuel-ferdman
emmanuel-ferdman
facus26
facus26
Fdawgs
Fdawgs
GreyXor
GreyXor
HelgeSverre
HelgeSverre
CJHwong
CJHwong
IceyWu
IceyWu
eltociear
eltociear
kevinand11
kevinand11
JacobCoffee
JacobCoffee
TheVaan
TheVaan
jonataw
jonataw
IHIutch
IHIutch