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 2 months 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 (about 2 years ago)
Default Branch: main
Last Pushed: 2025-09-03T16:34:02.000Z (2 months ago)
Last Synced: 2025-09-03T16:35:02.654Z (2 months ago)
Topics: api, api-client, docs, http-client, openapi, openapi3, reference, rest-api, swagger, vue
Language: Vue
Homepage: https://scalar.com
Size: 217 MB
Stars: 11,882
Watchers: 34
Forks: 463
Open Issues: 203
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-github-repos - scalar/scalar - Scalar is an open-source API platform:　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　🌐 Modern Rest API Client　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　📖 Beautiful API References　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　 (Vue)
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)
awesome - scalar/scalar - Scalar is an open-source API platform:　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　🌐 Modern Rest API Client　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　📖 Beautiful API References　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　✨ 1st-Class OpenAPI/Swagger Support (Vue)

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)
[![Twitter](https://img.shields.io/twitter/follow/scalar)](https://x.com/scalar)
[![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:

Scalar API client

### 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://registry.scalar.com/@scalar/apis/galaxy/latest?format=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](https://guides.scalar.com/scalar/scalar-api-references/integrations/htmljs) (works everywhere)
- [.NET ASP.NET Core](https://guides.scalar.com/scalar/scalar-api-references/integrations/net-aspnet-core/integration)
- [.NET Aspire](https://guides.scalar.com/scalar/scalar-api-references/integrations/net-aspire)
- [AdonisJS](https://guides.scalar.com/scalar/scalar-api-references/integrations/adonisjs)
- [Django Ninja](https://guides.scalar.com/scalar/scalar-api-references/integrations/django-ninja)
- [Django](https://guides.scalar.com/scalar/scalar-api-references/integrations/django)
- [Docker](https://guides.scalar.com/scalar/scalar-api-references/integrations/docker)
- [Docusaurus](https://guides.scalar.com/scalar/scalar-api-references/integrations/docusaurus)
- [Elixir](https://guides.scalar.com/scalar/scalar-api-references/integrations/elixir)
- [Express](https://guides.scalar.com/scalar/scalar-api-references/integrations/express)
- [FastAPI](https://guides.scalar.com/scalar/scalar-api-references/integrations/fastapi)
- [Fastify](https://guides.scalar.com/scalar/scalar-api-references/integrations/fastify)
- [Flask](https://guides.scalar.com/scalar/scalar-api-references/integrations/flask)
- [Go](https://guides.scalar.com/scalar/scalar-api-references/integrations/go)
- [Hapi](https://guides.scalar.com/scalar/scalar-api-references/integrations/hapi)
- [Hono](https://guides.scalar.com/scalar/scalar-api-references/integrations/hono)
- [Laravel Scribe](https://guides.scalar.com/scalar/scalar-api-references/integrations/laravel-scribe)
- [Laravel](https://guides.scalar.com/scalar/scalar-api-references/integrations/laravel)
- [Micronaut](https://guides.scalar.com/scalar/scalar-api-references/integrations/micronaut)
- [NestJS](https://guides.scalar.com/scalar/scalar-api-references/integrations/nestjs)
- [Next.js](https://guides.scalar.com/scalar/scalar-api-references/integrations/nextjs)
- [Nuxt](https://guides.scalar.com/scalar/scalar-api-references/integrations/nuxt)
- [Python](https://guides.scalar.com/scalar/scalar-api-references/integrations/python)
- [React](https://guides.scalar.com/scalar/scalar-api-references/integrations/react)
- [Ruby on Rails](https://guides.scalar.com/scalar/scalar-api-references/integrations/ruby-on-rails)
- [Rust](https://guides.scalar.com/scalar/scalar-api-references/integrations/rust)
- [Spring Boot](https://guides.scalar.com/scalar/scalar-api-references/integrations/spring-boot)
- [SvelteKit](https://guides.scalar.com/scalar/scalar-api-references/integrations/sveltekit)
- [Ts.ED](https://guides.scalar.com/scalar/scalar-api-references/integrations/tsed)
- [Vue.js](https://guides.scalar.com/scalar/scalar-api-references/integrations/vuejs)

### 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)
- [oRPC](https://orpc.unnoq.com/docs/openapi/plugins/openapi-reference)

### 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](https://www.npmjs.com/package/@scalar/cli) | Command-line interface |
| [Scalar Galaxy](packages/galaxy/README.md) | OpenAPI Example |
| [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](https://guides.scalar.com/scalar/scalar-api-references/themes) | Predefined themes, layouts & styling |
| [Configuration](https://guides.scalar.com/scalar/scalar-api-references/configuration) | The universal configuration object |
| [Plugins](https://guides.scalar.com/scalar/scalar-api-references/plugins) | Extend the functionality |
| [OpenAPI](https://guides.scalar.com/scalar/scalar-api-references/openapi) | OpenAPI and our extensions to it |
| [Markdown](https://guides.scalar.com/scalar/scalar-api-references/markdown) | The supported 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 (April 2025)**