Scalar API Reference

Add interactive API documentation to an existing application with the integration that matches its framework. Scalar renders an API description; preserve the application's existing description generator and API routes.

Choose the integration

Inspect the application's framework, package versions, routing conventions, and existing API description endpoint. Determine whether the user needs a standalone documentation route or a component embedded in the application layout.

Read the relevant entry in framework integrations, then consult its linked guide for options specific to that integration. Use the project's package manager. Match the installed version's exports and types instead of assuming every wrapper accepts the same option names.

For a plain HTML page, this is a minimal setup. Serve an API description at /openapi.json and serve the page over HTTP: