---
title: "Deploy Scalar API Reference"
description: "Modern API documentation for OpenAPI/Swagger"
category: "Other"
url: https://railway.com/deploy/scalar-api-reference
---

# Deploy Scalar API Reference

Modern API documentation for OpenAPI/Swagger

**[Deploy Scalar API Reference on Railway](https://railway.com/template/scalar-api-reference)**

- **Creator:** datadanmark's Projects
- **Category:** Other
- **Total deploys:** 2

## Template content

### Scalar API Reference https://scalar.com/brand/scalar-logomark-dark.svg

- **Image:** scalarapi/api-reference:latest
- **Health check:** /health
- **Public domain:** Yes

## Documentation

# 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](https://docs.scalar.com/swagger-editor)

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

- [Scalar API Reference docs](https://scalar.com/products/api-references/getting-started)
- [Scalar GitHub repository](https://github.com/scalar/scalar)
- [Configuration reference](https://scalar.com/products/api-references/configuration)

### 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](https://scalar.com/products/api-references/configuration) 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.

## Similar templates

- [Rocky Linux](https://railway.com/deploy/rocky-linux) — [Jul'26] Hosted Rocky Linux 9 workspace with SSH and persistent storage. 🚀
- [Foundry Virtual Tabletop](https://railway.com/deploy/X5tR6G) — A Self-Hosted & Modern Roleplaying Platform
- [Letta Code Remote](https://railway.com/deploy/letta-code-remote) — Run a Letta Code agent 24/7. No inbound ports, just deploy.

Open this page in a browser: https://railway.com/deploy/scalar-api-reference