https://github.com/scalar/scalar

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

api api-client docs http-client openapi openapi3 reference rest-api swagger vue

Last synced: about 13 hours ago
JSON representation

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

Host: GitHub
URL: https://github.com/scalar/scalar
Owner: scalar
License: mit
Created: 2023-08-16T13:42:32.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2025-04-17T14:54:52.000Z (1 day ago)
Last Synced: 2025-04-17T15:15:42.572Z (1 day ago)
Topics: api, api-client, docs, http-client, openapi, openapi3, reference, rest-api, swagger, vue
Language: TypeScript
Homepage: https://scalar.com
Size: 159 MB
Stars: 9,921
Watchers: 28
Forks: 342
Open Issues: 240
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

awesome - scalar/scalar - Scalar is an open-source API platform:　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　🌐 Modern Rest API Client　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　📖 Beautiful API References　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　✨ 1st-Class OpenAPI/Swagger Support (TypeScript)
awesome-github-repos - scalar/scalar - Scalar is an open-source API platform:　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　🌐 Modern Rest API Client　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　📖 Beautiful API References　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　 (TypeScript)
awesome-documentation - Scalar - Generate interactive API documentations from Swagger files. (Documentation Types / API Documentation)
jimsghstars - scalar/scalar - Scalar is an open-source API platform:　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　🌐 Modern Rest API Client　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　📖 Beautiful API References　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　 (TypeScript)

README

[![CI](https://github.com/scalar/scalar/actions/workflows/ci.yml/badge.svg)](https://github.com/scalar/scalar/actions/workflows/ci.yml)
[![Contributors](https://img.shields.io/github/contributors/scalar/scalar)](https://github.com/scalar/scalar/graphs/contributors)
[![GitHub License](https://img.shields.io/github/license/scalar/scalar)](https://github.com/scalar/scalar/blob/main/LICENSE)
[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)
[![Scalar App](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.todesktop.com%2Fv1%2FgetReleaseBuildIds%3FappId%3D240718bnjmcfyp4&query=%24.releases%5B%3A1%5D.version&label=Scalar%20App&labelColor=%231a1a1a&color=%23e7e7e7)](https://scalar.com/download)

Scalar

### 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:

```html

Scalar API Reference

Scalar.createApiReference('#app', {
// The URL of the OpenAPI/Swagger document
url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.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](documentation/integrations/html-js.md) (works everywhere)
- [.NET](integrations/aspnetcore/README.md)
- [AdonisJS](documentation/integrations/adonisjs.md)
- [Django](https://github.com/m1guer/django-scalar)
- [Django Ninja](integrations/django-ninja/README.md)
- [Docusaurus](integrations/docusaurus/README.md)
- [Express](integrations/express/README.md)
- [FastAPI](integrations/fastapi/README.md)
- [Fastify](integrations/fastify/README.md)
- [Go](documentation/integrations/go.md)
- [Hono](integrations/hono/README.md)
- [Laravel Scribe](documentation/integrations/laravel-scribe.md)
- [Micronaut](https://micronaut-projects.github.io/micronaut-openapi/latest/guide/index.html#scalar)
- [NestJS](integrations/nestjs/README.md)
- [Next.js](integrations/nextjs/README.md)
- [Nuxt](integrations/nuxt/README.md)
- [React](packages/api-reference-react/README.md)
- [Ruby on Rails](https://github.com/dmytroshevchuk/scalar_ruby)
- [Rust](documentation/integrations/rust.md)
- [Scalar for Laravel](https://github.com/scalar/laravel)
- [Ts.ED](https://tsed.dev/tutorials/scalar.html)
- [Vue.js](packages/api-reference/README.md)

### 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:

- [ElysiaJS](documentation/integrations/elysiajs.md)
- [HappyX](https://github.com/HapticX/happyx)
- [Litestar](https://docs.litestar.dev/latest/usage/openapi/ui_plugins.html)
- [Nitro](documentation/integrations/nitro.md)
- [Platformatic](documentation/integrations/platformatic.md)

### 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](https://scalar.com).

### Projects

| Project | Description |
| ----------------------------------------------------------- | ---------------------- |
| [Scalar API Client](packages/api-client/README.md) | API client |
| [Scalar CLI](packages/cli/README.md) | Command-line interface |
| [Scalar Galaxy](packages/galaxy/README.md) | OpenAPI Example |
| [Scalar Play Button](packages/play-button/README.md) | Quick API Client Embed |
| [Scalar Mock Server](packages/mock-server/README.md) | OpenAPI Mock Server |
| [Scalar Void Server](packages/void-server/README.md) | HTTP Request Mirror |
| [Scalar Open API Parser](packages/openapi-parser/README.md) | OpenAPI SDK |
| [Scalar Sandbox](https://sandbox.scalar.com/) | Online OpenAPI Editor |

### Documentation

| Topic | Description |
| ----------------------------------------------- | ---------------------------------- |
| [Themes](documentation/themes.md) | Themes, layouts & styling |
| [Configuration](documentation/configuration.md) | The universal configuration object |
| [OpenAPI](documentation/openapi.md) | OpenAPI and our extensions to it |
| [Markdown](documentation/markdown.md) | Markdown syntax |

### 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 (November 2024)**