Deploy and Host Scalar API Reference on Railway

Scalar API Reference renders OpenAPI/Swagger documents into modern, interactive API documentation.

Includes a built-in API testing client, code samples across multiple languages and frameworks, customizable theming, and 1st-class OpenAPI support. Free alternative to Swagger UI and Redoc.

Demo

About Hosting Scalar API Reference

Hosting Scalar API Reference means serving a lightweight web app that loads your OpenAPI/Swagger document and renders interactive docs.

Deployment serves static HTML + JavaScript bundle, pointed at your OpenAPI spec via URL or inline content.

Configuration is done through a Railway variable and covers theming, routing, authentication persistence, proxy settings for CORS, and telemetry.

Common Use Cases

Public API documentation portal for SaaS products and developer platforms
Internal API reference for engineering teams documenting microservices behind a private network
White-labeled docs site under custom domain with branded theming for client-facing APIs

Dependencies for Scalar API Reference Hosting

The template include all necessary dependencies.

Deployment Dependencies

Implementation Details

Add you OpenAPI/swagger definition to the variable API_REFERENCE_CONFIG and adjust the configuration according to your needs and preferences.

See Scarlar configuration reference for detail on what can be configured.

Why Deploy Scalar API Reference on Railway?

Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it.

By deploying Scalar API Reference on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.