How do I deploy Restapify on Railway?

You can deploy Restapify on Railway by clicking the "Deploy Now" button on this page. Railway will automatically set up all the necessary services and configurations for you.

What are the system requirements?

Railway handles all the infrastructure requirements. You only need a web browser to deploy and manage your application.

Is this template free to use?

Yes, this template is free to use within your existing Railway account.

Can I customize this template?

Yes, you can fully customize this template. After deployment, you will have full control of what you've deployed in your Railway project.

How do I get support for this template?

You can get support through our community forum, or click "Get template help" for this template for more assistance.

🚀 Restapify Template

Easily deploy a Restapify mock API to Railway — perfect for testing and frontend development when your backend isn't ready yet.

⚙️ Getting Started

🔧 Local Development

Install dependencies:

npm install
yarn install

Start the mock server:

npm run start
yarn start

Open your browser:

API base URL: http://localhost:6767/api/
Dashboard: http://localhost:6767/restapify

The dashboard provides a UI to explore and test your mock endpoints.

📦 Environment Variables

You can configure the mock server behavior using environment variables via a .env file:

Variable	Default	Description
`PORT`	`6767`	Port where the server runs locally
`PUBLIC_PATH`	`api/`	Base path for all mock routes
`PUBLIC_URL`	`http://localhost:6767`	Full URL used in logs and dashboard links
`OPEN_DASHBOARD_PATH`	`true` (only if local)	Open dashboard in browser when server starts (local only)

Example `.env` file:

PORT=6767
PUBLIC_PATH=api/
PUBLIC_URL=http://localhost:6767
OPEN_DASHBOARD_PATH=true

In Railway, PUBLIC_URL is set automatically via RAILWAY_PUBLIC_DOMAIN in most setups.

🌐 Example Routes Served

This template includes the following mocked endpoints:

GET    /api/me
GET    /api/posts
GET    /api/users
GET    /api/users/[userid]
POST   /api/users/[userid]
DELETE /api/users/[userid]
GET    /api/users/[userid]/comments

You can modify or extend these by editing the files in the api/ directory.

🚀 Deploy to Railway

Once deployed:

API: https://your-subdomain.up.railway.app/api/
Dashboard: https://your-subdomain.up.railway.app/restapify

📚 Documentation

📖 https://restapify.vercel.app/docs