JSPM

@scalar/api-reference

1.31.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 45610
  • Score
    100M100P100Q155099F
  • License MIT

Generate beautiful API references from OpenAPI documents

Package Exports

  • @scalar/api-reference
  • @scalar/api-reference/browser/standalone.js
  • @scalar/api-reference/style.css

Readme

Scalar API Reference

Version Downloads Hits on jsdelivr License Discord

Interactive API Reference from OpenAPI/Swagger Documents Try our Demo

Screenshot of an API Reference

CDN

<!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>
    <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://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
        // Avoid CORS issues
        proxyUrl: 'https://proxy.scalar.com',
      })
    </script>
  </body>
</html>

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.