ScalarScalar API

Getting Started

Reading this guide helps you to get started with our wonderful Open-Source API References as quick as possible.

Our most simplest example is using the CDN integration of our API References

<!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>

Need a Custom Header? Check out this example: https://codepen.io/scalarorg/pen/VwOXqam

CustomizationCopied!

Topic Description
Themes Predefined themes, layouts & styling
Configuration The universal configuration object
Plugins Extend the functionality
OpenAPI OpenAPI and our extensions to it
Markdown The supported Markdown syntax

And there’s an ever-growing list of plugins and integrations:

IntegrationsCopied!

Built-in SupportCopied!

The following frameworks have chosen Scalar API Reference as their default OpenAPI documentation UI, recognizing its developer-friendly features and modern design: