scalar

Scalar is an open-source platform with:　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　🌐 Modern Rest API Client　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　📖 Beautiful API References　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　✨ 1st-Class OpenAPI/Swagger Support

MIT License

Downloads

2.6M

Stars

6.4K

Committers

View Code on GitHub Visit Website Twitter

Ecosystems: OpenAPI Specification, YAML, Vue.js

An offline first API Client built for OpenAPI

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