### Interactive API Reference from OpenAPI/Swagger
└ Renders OpenAPI/Swagger documents
└ Comes with an API testing tool
└ Doesn't look like 2011
└ Generates code examples for many languages & frameworks
└ Integrates with your favorite framework
└ Try Demo
### An offline-first API Client built for OpenAPI
└ Free and open-source
└ First-class OpenAPI/Swagger support
└ Integrates with dozens of API Frameworks (Elysia, Hono, FastAPI, etc)
└ Syncs with your favorite server framework (Watch Mode)
└ Has environment variables, dynamic parameters and everything
└ Try It in the Browser
└ Download (Windows, MacOS, Linux)
### Trusted by:
### Quickstart
All you need is a single HTML file to create an amazing API reference:
```html
Scalar API Reference
```
> 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://scalar.com/products/api-references/integrations/html-js) (works everywhere)
- [.NET ASP.NET Core](https://scalar.com/products/api-references/integrations/aspnetcore/integration)
- [Aspire](https://scalar.com/products/api-references/integrations/aspire)
- [AdonisJS](https://scalar.com/products/api-references/integrations/adonisjs)
- [Astro](https://scalar.com/products/api-references/integrations/astro)
- [Django Ninja](https://scalar.com/products/api-references/integrations/django-ninja)
- [Django](https://scalar.com/products/api-references/integrations/django)
- [Docker](https://scalar.com/products/api-references/integrations/docker)
- [Docusaurus](https://scalar.com/products/api-references/integrations/docusaurus)
- [Elixir](https://scalar.com/products/api-references/integrations/elixir)
- [Express](https://scalar.com/products/api-references/integrations/express)
- [FastAPI](https://scalar.com/products/api-references/integrations/fastapi)
- [Fastify](https://scalar.com/products/api-references/integrations/fastify)
- [Flask](https://scalar.com/products/api-references/integrations/flask)
- [Go](https://scalar.com/products/api-references/integrations/go)
- [Hapi](https://scalar.com/products/api-references/integrations/hapi)
- [Hono](https://scalar.com/products/api-references/integrations/hono)
- [Laravel Scribe](https://scalar.com/products/api-references/integrations/laravel-scribe)
- [Laravel](https://scalar.com/products/api-references/integrations/laravel)
- [Micronaut](https://scalar.com/products/api-references/integrations/micronaut)
- [NestJS](https://scalar.com/products/api-references/integrations/nestjs)
- [Next.js](https://scalar.com/products/api-references/integrations/nextjs)
- [Nuxt](https://scalar.com/products/api-references/integrations/nuxt)
- [Python](https://scalar.com/products/api-references/integrations/python)
- [React](https://scalar.com/products/api-references/integrations/react)
- [Ruby on Rails](https://scalar.com/products/api-references/integrations/ruby-on-rails)
- [Rust](https://scalar.com/products/api-references/integrations/rust)
- [Spring Boot](https://scalar.com/products/api-references/integrations/spring-boot)
- [SvelteKit](https://scalar.com/products/api-references/integrations/sveltekit)
- [Ts.ED](https://scalar.com/products/api-references/integrations/tsed)
- [Vue.js](https://scalar.com/products/api-references/integrations/vue)
### 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:
- [Effect](https://scalar.com/products/api-references/integrations/effect)
- [ElysiaJS](https://scalar.com/products/api-references/integrations/elysiajs)
- [HappyX](https://github.com/HapticX/happyx)
- [Litestar](https://docs.litestar.dev/latest/usage/openapi/ui_plugins.html)
- [Nitro](https://scalar.com/products/api-references/integrations/nitro)
- [oRPC](https://orpc.unnoq.com/docs/openapi/plugins/openapi-reference)
- [Platformatic](https://scalar.com/products/api-references/integrations/platformatic)
- [Spry](https://scalar.com/products/api-references/integrations/spry)
### Managed Hosting
We're offering a free and paid managed hosting on the edge, too:
- Write your API documentation and publish API references (free)
- `YOUR_NAME_HERE.apidocumentation.com` subdomain and SSL (free)
- [GitHub Sync](https://scalar.com/products/docs/github-sync)
- Write free-form documentation
- Collaborate with your team
- Use any domain
Ready? [Create your Scalar Account](https://scalar.com)
### Documentation
| Topic | Description |
| ------------------------------------------------------------------------- | ------------------------------------ |
| [Configuration](https://scalar.com/products/api-references/configuration) | The universal configuration object |
| [Themes](https://scalar.com/products/api-references/themes) | Predefined themes, layouts & styling |
| [OpenAPI](https://scalar.com/products/api-references/openapi) | OpenAPI specification extensions |
| [Markdown](https://scalar.com/products/api-references/markdown) | Supported Markdown syntax |
| [Plugins](https://scalar.com/products/api-references/plugins) | Extend the functionality |
### Projects
| Project | Description |
| ---------------------------------------------------------------------------------- | -------------------------------- |
| [Scalar API Reference](https://scalar.com/products/api-references/getting-started) | Self-hosted API Reference |
| [Scalar API Client](https://scalar.com/download) | Postman alternative |
| [Agent Scalar](https://scalar.com/products/agent/getting-started) | Chat with your API |
| [Scalar Registry](https://scalar.com/products/registry/getting-started) | Manage OpenAPI documents |
| [Scalar Docs](https://scalar.com/products/docs/getting-started) | Hosted documentation |
| [Scalar Docs Starter](https://github.com/scalar/starter) | Starter template for Scalar Docs |
| [Scalar SDKs](https://scalar.com/products/sdks/getting-started) | SDK generation |
| [Scalar CLI](https://scalar.com/tools/cli/getting-started) | Command-line interface |
| [Scalar Mock Server](https://scalar.com/tools/mock-server/getting-started) | Mock APIs from OpenAPI documents |
| [Scalar Galaxy](packages/galaxy/README.md) | Our OpenAPI Example |
| [Scalar Editor](https://editor.scalar.com/) | OpenAPI Online Editor |
| [Scalar OpenAPI Parser](packages/openapi-parser/README.md) | Parse OpenAPI documents |
| [Scalar OpenAPI to Markdown](packages/openapi-to-markdown/README.md) | OpenAPI > Markdown/HTML |
| [Scalar OpenAPI Upgrader](packages/openapi-upgrader/README.md) | Upgrade OpenAPI documents |
| [Scalar Void Server](packages/void-server/README.md) | HTTP Request Mirror |
### 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)**