​

Testing Routes

​

What is the Route Tester?

• ✅ Test route configuration without writing code
• ✅ See exactly what headers/body are sent to your backend
• ✅ Verify secrets are injected correctly
• ✅ Test different HTTP methods
• ✅ Debug issues before going live
• ✅ No need for Postman or curl

​

Access the Route Tester

​

Option 1: From Route List

1. Navigate to Routes
2. Find your route
3. Click the Test button (🧪 icon)

​

Option 2: From Route Details

1. Navigate to Routes
2. Click your route to open details
3. Click Test Route tab
4. Or click Test button in header

​

Using the Route Tester

​

Step 1: Select HTTP Method

• GET
• POST
• PUT
• DELETE
• PATCH
• OPTIONS
• HEAD

​

Step 2: Enter Path

• Include leading slash: /api/users ✅
• No leading slash: api/users ⚠️ (works but inconsistent)
• Can include query params: /users?status=active

​

Step 3: Add Query Parameters (Optional)

1. Sent to backend
2. Available in templates as {{vars.param_name}}

​

Step 4: Add Request Headers (Optional)

​

Step 5: Add Request Body (Optional)

{
  "name": "John Doe",
  "email": "[email protected]",
  "status": "active"
}

name=John+Doe&[email protected]

Any raw text or data

​

Step 6: Select Environment (Optional)

• production (default)
• staging
• development
• Custom environments

​

Step 7: Click “Send Test Request”

1. Apply route configuration
2. Inject secrets (if any)
3. Apply environment overrides (if any)
4. Apply method-specific config (if any)
5. Send request to backend
6. Return response

​

Understanding Test Results

​

Request Details Section

https://api.example.com/users/123?filter=active

POST

Authorization: Bearer sk_live_abc123xyz789...
Content-Type: application/json
X-Custom-Header: test-value
X-Forwarded-For: 192.168.1.1

• Authorization header was injected from route config
• Secret was decrypted and value inserted
• Custom headers are included

{
  "name": "John Doe",
  "email": "[email protected]",
  "api_key": "sk_live_abc123..."
}

• api_key was injected from body template
• Secret was decrypted

​

Response Details Section

200 OK

Content-Type: application/json
X-Request-ID: req_abc123
Cache-Control: no-cache

{
  "id": 123,
  "name": "John Doe",
  "email": "[email protected]",
  "created_at": "2025-01-15T10:30:00Z"
}

245ms

​

Config Applied Section

production

POST method config (overrides global)

- stripe_api_key → sk_live_abc... (in Authorization header)
- database_url → postgres://... (in body)

Not enforced in test mode

Not required in test mode

​

Example Test Scenarios

​

Scenario 1: Test Secret Injection

1. Select method: POST
2. Path: /charges
3. Body:
   Copy

   {
     "amount": 1000,
     "currency": "usd"
   }
   
4. Send request

• Request headers show: Authorization: Bearer sk_live_... (actual key, not template)
• Response from Stripe API (charge created)
• No errors about authentication

​

Scenario 2: Test Method-Specific Config

1. Method: GET
2. Path: /users
3. Send request
4. Check: Authorization header uses read_key

1. Method: POST
2. Path: /users
3. Body: {"name": "Test"}
4. Send request
5. Check: Authorization header uses write_key

​

Scenario 3: Test Environment Override

1. Method: GET
2. Path: /health
3. Environment: staging
4. Send request

• Request URL shows staging URL: https://staging-api.example.com/health
• Not production URL

​

Scenario 4: Test Query Param Variables

1. Method: GET
2. Path: /users
3. Query params:
   • filter = active
4. Send request

• Request headers show: X-Filter: active (variable replaced)
• Not: X-Filter: {{vars.filter}} (literal template)

​

Scenario 5: Test Error Handling

1. Method: POST
2. Path: /users
3. Body:
   Copy

   {
     "email": "invalid-email"
   }
   
4. Send request

• Status code: 400 Bad Request
• Response body shows validation error
• Error message is clear

​

Common Test Cases

​

✅ Before Going Live Checklist

• GET request works
  • Returns expected data
  • Correct headers injected
  • Secrets work
• POST request works
  • Creates resource successfully
  • Body template works
  • Secrets injected correctly
• PUT/PATCH request works
  • Updates resource
  • Idempotency works (if applicable)
• DELETE request works
  • Deletes resource
  • Correct permissions
• Test each environment
  • Production URL
  • Staging URL
  • Development URL
• Test method configs
  • Each method uses correct config
  • Secrets differ per method
• Test error cases
  • Invalid data returns 400
  • Missing auth returns 401
  • Not found returns 404
• Test with real data
  • Not just test values
  • Actual production-like payloads

​

Troubleshooting with Route Tester

​

Issue: “Connection refused”

• Target URL is wrong
• Backend server is down
• Firewall blocking KnoxCall IPs

1. Check target URL in route config
2. Verify backend is running: curl https://your-backend.com/health
3. Check backend firewall allows KnoxCall IPs

​

Issue: “401 Unauthorized”

• Secret not injected
• Wrong secret value
• Secret expired

1. Check “Request Headers” section
2. Verify Authorization header present
3. Check secret value is correct (not template literal)
4. Test secret directly with backend

​

Issue: Template Not Replaced

• Secret doesn’t exist
• Typo in secret name
• Wrong template syntax

1. Check “Secrets Injected” section
2. Verify secret exists: Secrets page
3. Check spelling: {{secret:api_key}} not {{api_key}}

​

Issue: “502 Bad Gateway”

• Backend took too long (timeout)
• Backend returned invalid response
• Backend crashed

1. Check response time (>30 seconds?)
2. Check backend logs for errors
3. Test backend directly: curl https://your-backend.com/endpoint

​

Issue: Wrong Environment Used

1. Check environment dropdown selection
2. Verify environment override exists
3. Check “Config Applied” section shows correct environment

​

Advanced Testing

​

Test with cURL Export

1. Configure test in UI
2. Click Export as cURL
3. Copy command
4. Run in terminal:
   Copy

   curl -X POST "https://api.example.com/users" \
     -H "Authorization: Bearer sk_live_..." \
     -H "Content-Type: application/json" \
     -d '{"name":"John"}'
   

• Automated testing
• CI/CD pipelines
• Sharing with team

​

Test with Postman Import

1. Configure test
2. Click Export as Postman
3. Import in Postman
4. Run collection

​

Test from Logs

1. Navigate to Logs
2. Find a request
3. Click Replay in Tester
4. Tester pre-fills with request details
5. Modify and re-send

​

Best Practices

​

1. Test Before Deploy

​

2. Test All Methods

​

3. Test All Environments

​

4. Test Error Cases

​

5. Save Test Cases

​

6. Test After Changes

• Route config
• Secrets
• Environment overrides
• Backend URL

​

7. Use Real Data

​

8. Check Response Times

​

Limitations

​

Rate Limiting Bypassed

​

IP Authorization Skipped

​

Signatures Not Required

​

Real Backend Impact

​

Related Features

• Method Configs: Test different configs per HTTP method
• Environments: Test staging before production
• Secrets: Verify secrets inject correctly
• Logs: View historical requests and replay them

​

Next Steps