# scalar **Repository Path**: chhw/scalar ## Basic Information - **Project Name**: scalar - **Description**: scalar 是从 OpenAPI/Swagger 文件生成美观的 API 参考文档 。 该项目主要解决了从 OpenAPI/Swagger 文件生成交互式 API 文档的问题。 使用 OpenAPI/Swagger 规范 支持大量语言和框架的请求示例 集成了 API 客户端 实时预览编辑你的 OpenAPI/Swagger 规范 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: amrit/auth-compliant-1 - **Homepage**: https://scalar.com/ - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2025-03-21 - **Last Updated**: 2025-03-21 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## 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

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: ```html Scalar API Reference ``` And there’s an ever-growing list of plugins and integrations: ### Integrations - [HTML](documentation/integrations/html.md) - [.NET](packages/scalar.aspnetcore/README.md) - [AdonisJS](documentation/integrations/adonisjs.md) - [Django Ninja](packages/scalar_django_ninja/README.md) - [Docusaurus](packages/docusaurus/README.md) - [ElysiaJS](documentation/integrations/elysiajs.md) - [Express](packages/express-api-reference/README.md) - [FastAPI](packages/scalar_fastapi/README.md) - [Fastify](packages/fastify-api-reference/README.md) - [Go](documentation/integrations/go.md) - [Hono](packages/hono-api-reference/README.md) - [Scalar for Laravel](https://github.com/scalar/laravel) - [Laravel Scribe](documentation/integrations/laravel-scribe.md) - [Litestar](https://docs.litestar.dev/latest/usage/openapi/ui_plugins.html) - [NestJS](packages/nestjs-api-reference/README.md) - [Next.js](packages/nextjs-api-reference/README.md) - [Nitro](documentation/integrations/nitro.md) - [Nuxt](packages/nuxt/README.md) - [Platformatic](documentation/integrations/platformatic.md) - [React](packages/api-reference-react/README.md) - [Rust](documentation/integrations/rust.md) - [Vue.js](packages/api-reference/README.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 (September 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
adjsky
adjsky
mcollina
mcollina
Mohib834
Mohib834
Edgaraszs
Edgaraszs
ATREAY
ATREAY
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
rpmccarter
rpmccarter
rmp135
rmp135
STP5940
STP5940
captainsafia
captainsafia
realsama
realsama
SebastianBienert
SebastianBienert
dotfortun
dotfortun
hrynevychroman
hrynevychroman
rbange
rbange
rickihastings
rickihastings
MaxBreida
MaxBreida
MarioGK
MarioGK
ShadiestGoat
ShadiestGoat
alewin
alewin
soGit
soGit
sinh117801
sinh117801
thibaultleouay
thibaultleouay
Courtcircuits
Courtcircuits
Mai0313
Mai0313
wilcoschoneveld
wilcoschoneveld
yshrsmz
yshrsmz
ruizhiii
ruizhiii
Chinlinlee
Chinlinlee
WilliamBonvini
WilliamBonvini
danwithabox
danwithabox
FotieMConstant
FotieMConstant
ga1az
ga1az
dunklesToast
dunklesToast
tsiwek-piwik
tsiwek-piwik
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
elliotnash
elliotnash
emmanuel-ferdman
emmanuel-ferdman
facus26
facus26
Fdawgs
Fdawgs
GreyXor
GreyXor
HelgeSverre
HelgeSverre
CJHwong
CJHwong
ivanagas
ivanagas
IceyWu
IceyWu
eltociear
eltociear
kevinand11
kevinand11
JacobCoffee
JacobCoffee
TheVaan
TheVaan
jonataw
jonataw
IHIutch
IHIutch
KiARC
KiARC
kyllian
kyllian
sanscontext
sanscontext