Scalar API Reference
Generate interactive API documentation from OpenAPI/Swagger documents. Try our Demo
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
- HTML
- .NET
- AdonisJS
- Docusaurus
- ElysiaJS
- Express
- FastAPI
- Fastify
- Go
- Hono
- Laravel
- Litestar
- NestJS
- Next.js
- Nitro
- Nuxt
- Platformatic
- React
- Rust
- Vue.js
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.comsubdomain (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 |
Documentation
| Topic | Description |
|---|---|
| Themes | Themes, layouts & styling |
| Configuration | The universal configuration object |
| OpenAPI | OpenAPI and our extensions to it |
| Markdown | Markdown syntax |
Community
We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar
Note
Scalar Townhall every 2nd Thursday in Discord
Join us to see upcoming features, discuss the roadmap and chat about APIs. 💬
Contributors
Contributions are welcome! Read the CONTRIBUTING guide.
