@scalar/api-reference
TypeScript icon, indicating that this package has built-in type declarations

1.31.3 • Public • Published

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.

Package Sidebar

Install

npm i @scalar/api-reference

Weekly Downloads

38,724

Version

1.31.3

License

MIT

Unpacked Size

4.66 MB

Total Files

550

Last publish

Collaborators

  • amritkahlon
  • cameronrohani
  • marclave
  • tommastro
  • scalar_geoff
  • hwkr
  • mason-little
  • hanspagel
  • bgrcs