@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
56 lines (41 loc) • 1.99 kB
Markdown
# Scalar API Reference
[](https://www.npmjs.com/package/@scalar/api-reference)
[](https://www.npmjs.com/package/@scalar/api-reference)
[](https://www.jsdelivr.com/package/npm/@scalar/api-reference)
[](https://www.npmjs.com/package/@scalar/api-reference)
[](https://discord.gg/scalar)
Interactive API Reference from OpenAPI/Swagger Documents [Try our Demo](https://docs.scalar.com/swagger-editor)
[](https://docs.scalar.com/swagger-editor)
### CDN
```html
<html>
<head>
<title>Scalar API Reference</title>
<meta charset="utf-8" />
<meta
name="viewport"
content="width=device-width, initial-scale=1" />
</head>
<body>
<div id="app"></div>
<!-- Load the Script -->
<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
<!-- Initialize the Scalar API Reference -->
<script>
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',
})
</script>
</body>
</html>
```
## Documentation
[Read the documentation here](https://guides.scalar.com/scalar/scalar-api-references/integrations/htmljs)
## Community
We are API nerds. You too? Let's chat on Discord: <https://discord.gg/scalar>
## License
The source code in this repository is licensed under [MIT](https://github.com/scalar/scalar/blob/main/LICENSE).