<h1> Scalar <a href="https://docs.scalar.com/swagger-editor" target="_blank"> <picture> <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/9b639f2d-0204-4b15-b918-158072a9afa5"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/be723d07-ec9c-4edb-b657-05a8bc05c7d6"> <img width="48.494%" height="250" src="https://github.com/user-attachments/assets/9b639f2d-0204-4b15-b918-158072a9afa5#gh-light-mode-only" alt="Scalar API Reference"> </picture> </a> <a href="https://scalar.com/download" target="_blank"> <picture> <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/b391b82f-d993-4e97-8a17-1c3c7ccbb19b"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/579d0853-b2a5-4ea8-b2bd-a98753faeaf3"> <img width="48.494%" height="250" src="https://github.com/user-attachments/assets/b391b82f-d993-4e97-8a17-1c3c7ccbb19b#gh-light-mode-only" alt="Scalar API client"> </picture> </a> </h1> <img width="830" height="auto" src="https://github.com/user-attachments/assets/3a24fc5c-5d3c-4be4-8b9e-399bd49e4fb7#gh-light-mode-only"> <img width="830" height="auto" src="https://github.com/user-attachments/assets/76f123ae-f458-409f-84d3-b9ad14fd3fb2#gh-dark-mode-only">

Interactive API Reference from OpenAPI/Swagger

└ Renders OpenAPI/Swagger documents └ Comes with an API testing tool └ Doesn't look like 2011 └ Generates code examples for many languages & frameworks └ Integrates with your favorite framework └ <a href="https://docs.scalar.com/swagger-editor">Try Demo</a>

<img width="1200" height="1" src="https://github.com/user-attachments/assets/7d7e7ba7-2b02-49f3-abcd-b24c566a3c16#gh-light-mode-only"> <img width="1200" height="1" src="https://github.com/user-attachments/assets/341bfb1d-5cb0-4ec6-89eb-4b1dcc07eeb7#gh-dark-mode-only">  <img width="830" height="auto" src="https://github.com/user-attachments/assets/d9f90c51-82d4-4948-9365-658ccc7d78c4#gh-light-mode-only"> <img width="830" height="auto" src="https://github.com/user-attachments/assets/e7c2023e-dfbc-428c-bc85-c06d8a6e4b67#gh-dark-mode-only">

An offline-first API Client built for OpenAPI

└ Free and open-source └ First-class OpenAPI/Swagger support └ Integrates with dozens of API Frameworks (Elysia, Hono, FastAPI, etc) └ Syncs with your favorite server framework (Watch Mode) └ Has environment variables, dynamic parameters and everything └ <a href="https://client.scalar.com/">Try It in the Browser</a> └ <a href="https://scalar.com/download">Download (Windows, MacOS, Linux)</a>

Trusted by:

Quickstart

All you need is a single HTML file to create an amazing API reference:

<!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://registry.scalar.com/@scalar/apis/galaxy?format=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

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

Integrations

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 API references (free)
YOUR_NAME_HERE.apidocumentation.com subdomain and SSL (free)
GitHub Sync
Write free-form documentation
Collaborate with your team
Use any domain

Ready? Create your Scalar Account

Documentation

| Topic | Description | | ------------------------------------------------------------------------- | ------------------------------------ | | Configuration | The universal configuration object | | Themes | Predefined themes, layouts & styling | | OpenAPI | OpenAPI specification extensions | | Markdown

Scalar

Install / Use

README