Skip to content

scalar/mock-server-playground

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scalar Mock Server Playground

Contributors GitHub License Twitter Discord

  • Experiment with the Scalar Mock Server
  • Test endpoints with mock responses
  • Run everything in your browser via GitHub Codespaces

Workshop

API Prototyping in Practice: From Design to Validation

  • Tuesday, December 9th, 3:00 pm – 3:55 pm
  • API Days Paris, Aubépine 4
  • Bruno Pedro & Hans Pagel

https://www.apidays.global/events/paris

Usage

Setup

  1. Open the GitHub repository in your browser
  2. Create a new Codespace by clicking the green "Code" button and selecting "Codespaces" → "Create codespace on main"
  3. Wait for setup (dependencies are installed automatically)
  4. Server starts automatically

Playing with the Mock Server

  1. Open the "Ports" tab in VS Code to find the URL
  2. Click on the port forwarding URL (port 3000) to open it in the browser
  3. You'll see the Scalar API Reference
  4. Use the built-in API client to test endpoints and see mock responses

Making Changes

  • Update documents/example.yaml to modify the API definition
  • The server restarts when you save changes
  • Simply refresh the browser to see your changes

Documentation

Read the full documentation here

Community

We are API nerds. You too? Let's chat on Discord: https://discord.gg/scalar

License

The source code in this repository is licensed under MIT.