API Explorer

The API Explorer automatically discovers all HTTP routes defined in your src/ directory and displays them in a Swagger-like interface.

How Routes Are Discovered#

Studio scans your src/ directory for route definitions using pattern matching. It detects calls like:

app.get('/users', handler)
app.post('/users', authenticate(jwt), validate(...), handler)
router.put('/users/:id', handler)

Routes are grouped by their first path segment for easier navigation.

Route Information#

Each route displays:

Expanding a Route#

Click any route to expand it and see:

• Path Parameters — Detected :param segments with type and required status
• Responses — Standard HTTP response codes (200, 400, 401, 404, 500)
• Request Body — Sample JSON body for POST, PUT, and PATCH routes
• Sample Response — Auto-generated example response based on the route path

Try It Out#

Every route has a built-in Try It Out panel. Click the Try it button to expand it:

URL           http://localhost:3000/users/1
Authorization Bearer your-token-here
Body          { "name": "John Doe" }
 
[ Send ]

After sending, you see:

• Status badge — 200 OK, 404 Not Found, etc. with color coding
• Response time — In milliseconds
• Response body — Pretty-printed JSON

Filtering Routes#

Use the search bar at the top to filter by:

• Method (get, post, delete)
• Path segment (/users, /auth)
• Handler name (createUser)

Use the method filter buttons to show only GET, POST, PUT, PATCH, or DELETE routes.

Middleware Detection#

Studio detects common middleware patterns and shows them as tags:

Path Parameters#

Routes with path parameters like /users/:id show the parameters in the detail panel:

PARAMETERS
:id     string     path     required