Gathering detailed insights and metrics for @scalar/api-reference-react
Gathering detailed insights and metrics for @scalar/api-reference-react
Scalar is an open-source API platform: 🌐 Modern Rest API Client 📖 Beautiful API References ✨ 1st-Class OpenAPI/Swagger Support
Installations
npm install @scalar/api-reference-reactReleases
Unable to fetch releases
Developer
Developer Guide
BETA
Module System
ESM
Min. Node Version
>=18
Typescript Support
Yes
Node Version
20.18.1
NPM Version
10.8.2
Statistics
7,616 Stars
3,456 Commits
239 Forks
24 Watching
128 Branches
90 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (63.01%)
Vue (28.33%)
CSS (3.77%)
C# (2.68%)
JavaScript (0.73%)
Python (0.63%)
HTML (0.54%)
Dockerfile (0.2%)
Shell (0.12%)
Total Downloads
Cumulative downloads
Total Downloads
173,561
Last day
-10.2%
1,537
Compared to previous day
Last week
3.6%
8,469
Compared to previous week
Last month
32.9%
34,979
Compared to previous month
Last year
0%
173,561
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
1
Versions
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:
1<!doctype html> 2<html> 3 <head> 4 <title>Scalar API Reference</title> 5 <meta charset="utf-8" /> 6 <meta 7 name="viewport" 8 content="width=device-width, initial-scale=1" /> 9 </head> 10 <body> 11 <!-- Need a Custom Header? Check out this example: https://codepen.io/scalarorg/pen/VwOXqam --> 12 <!-- Note: We’re using our public proxy to avoid CORS issues. You can remove the `data-proxy-url` attribute if you don’t need it. --> 13 <script 14 id="api-reference" 15 data-url="https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml" 16 data-proxy-url="https://proxy.scalar.com"></script> 17 18 <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script> 19 </body> 20</html>
And there’s an ever-growing list of plugins and integrations:
Integrations
- HTML (works everywhere)
- .NET
- AdonisJS
- Django Ninja
- Docusaurus
- Express
- FastAPI
- Fastify
- Go
- Hono
- Laravel Scribe
- NestJS
- Next.js
- Nuxt
- React
- Rust
- Scalar for Laravel
- Vue.js
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:
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
Contributions
Contributions are welcome! Read the CONTRIBUTING guide.
Top 10 Contributors (November 2024)
Top Contributors (All Time)
No vulnerabilities found.
No security vulnerabilities found.