Scalar API Reference

Generate interactive API documentations from Swagger files. Try our Demo

Installation

npm install @scalar/api-reference

Usage

<template>
  
</template>

CDN

  
    <title>Scalar API Reference</title>
    
    
  
  
    
    
    

    
    

    
  

You can also use the following syntax to directly pass an OpenAPI specification:

If you’d like to add a request proxy for the API client (to avoid CORS issues):

Events [beta]

We have recently added two events to the standalone CDN build only.

scalar:reload-references

Reload the references, this will re-mount the app in case you have switched pages or the dom elements have been removed.

document.dispatchEvent(new Event('scalar:reload-references'))

scalar:update-references-config

If you have updated the config or spec, you can trigger this event with the new payload to update the app. It should update reactively so you do not need to trigger the reload event above after.

import { type ReferenceProps } from './types'

const ev = new CustomEvent('scalar:update-references-config', {
  detail: {
    configuration: {
      spec: {
        url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml',
      },
    },
  } satisfies ReferenceProps,
})
document.dispatchEvent(ev)

Vue.js

The API Reference is built in Vue.js. If you’re working in Vue.js, too, you can directly use our Vue components. Install them via npm:

npm install @scalar/api-reference

And import the ApiReference component and style to your app:

<template>
  
</template>

You can pass props to customize the API reference.

Community

We are API nerds. You too? Let’s chat on Discord:

License

The source code in this repository is licensed under MIT.