How to test APIs using Replit

Press the Run button to start your backend server. The Console pane will show your server's startup output, including the port it is listening on. Next, open a Shell tab by clicking Tools in the left sidebar and selecting Shell. Arrange your workspace with the editor on the left, Console in the top-right, and Shell in the bottom-right. This layout lets you edit code, see server logs, and run test commands simultaneously without switching tabs.

In Shell, use curl to send a GET request to your local server. Replit exposes your running app at localhost on the port configured in your .replit file. The -s flag silences progress output, and piping through json_pp (or jq if installed) formats the response for readability. Check that the response status code and body match what you expect. If you get 'Connection refused,' your server may not be running or may be listening on a different port.

1# Test a basic GET endpoint
2curl -s http://localhost:3000/api/users | json_pp
3
4# Include response headers to see status code
5curl -s -I http://localhost:3000/api/users

To test POST endpoints, use curl with the -X POST flag, set the Content-Type header to application/json, and pass a JSON body with the -d flag. This simulates what your frontend or a client application would send. Watch the Console pane for server-side logs that confirm the request was received and processed. If you get a 400 or 422 error, your request body likely does not match the validation schema your server expects.

1# Test a POST endpoint with JSON body
2curl -s -X POST http://localhost:3000/api/users \
3  -H "Content-Type: application/json" \
4  -d '{"name": "Jane Doe", "email": "jane@example.com"}' | json_pp
5
6# Test PUT (update) endpoint
7curl -s -X PUT http://localhost:3000/api/users/1 \
8  -H "Content-Type: application/json" \
9  -d '{"name": "Jane Smith"}' | json_pp
10
11# Test DELETE endpoint
12curl -s -X DELETE http://localhost:3000/api/users/1

For endpoints that require API keys or bearer tokens, store your credentials in Replit Secrets (Tools -> Secrets) and reference them in your curl commands using the $VARIABLE_NAME syntax. Never hardcode API keys or tokens in your Shell history or code files. After adding a secret, you may need to run kill 1 in Shell to restart your environment and make the new secret available as an environment variable.

1# Store your API key in Secrets first, then use it:
2curl -s http://localhost:3000/api/protected \
3  -H "Authorization: Bearer $API_TOKEN" | json_pp
4
5# Test with an external API using a stored key
6curl -s https://api.example.com/data \
7  -H "x-api-key: $EXTERNAL_API_KEY" | json_pp

For APIs with many endpoints, create a test script file instead of running individual curl commands. Create a file called test-api.js (or test_api.py for Python) in your project root. Use fetch (built into Node.js 18+) or the requests library in Python to call each endpoint and log the results. Run the script in Shell with node test-api.js. This approach is faster for repeated testing and lets you add assertions to catch regressions.

1// test-api.js — Run with: node test-api.js
2const BASE = 'http://localhost:3000/api';
3
4async function testEndpoints() {
5  // Test GET /api/users
6  const users = await fetch(`${BASE}/users`);
7  console.log('GET /users:', users.status, await users.json());
8
9  // Test POST /api/users
10  const created = await fetch(`${BASE}/users`, {
11    method: 'POST',
12    headers: { 'Content-Type': 'application/json' },
13    body: JSON.stringify({ name: 'Test User', email: 'test@example.com' })
14  });
15  console.log('POST /users:', created.status, await created.json());
16
17  // Test GET /api/users/1
18  const single = await fetch(`${BASE}/users/1`);
19  console.log('GET /users/1:', single.status, await single.json());
20}
21
22testEndpoints().catch(console.error);

When an API request returns an error, the Console pane shows the server-side perspective. Look for stack traces, validation errors, and database query failures in the Console output. Add structured logging to your server code so every request logs the method, path, status code, and response time. This makes it much easier to correlate a Shell curl command with the server's internal processing. Client-side JavaScript logs appear only in the Preview pane's DevTools, not in Console.

1// Add request logging middleware to Express
2app.use((req, res, next) => {
3  const start = Date.now();
4  res.on('finish', () => {
5    console.log(`${req.method} ${req.path} ${res.statusCode} ${Date.now() - start}ms`);
6  });
7  next();
8});