Recording Proxy

How It Works

1. Start the proxy pointing at your target server
2. Send requests through the proxy (manually or from your app)
3. Stop the proxy (Ctrl+C)
4. hitspec exports all captured traffic as a .http file

Quick Start

# Start recording proxy
hitspec record --port 8080 --target https://api.example.com

# In another terminal, send requests through the proxy
curl http://localhost:8080/users
curl -X POST http://localhost:8080/users -d '{"name":"John"}'

# Press Ctrl+C to stop and export

Flags

Examples

hitspec record --target https://api.example.com -o recorded.http

hitspec record \
  --target https://api.example.com \
  --exclude "/health,/metrics" \
  -o recorded.http

hitspec record \
  --target https://api.example.com \
  --dedupe \
  -o recorded.http

hitspec record \
  --target https://api.example.com \
  --json \
  -o recorded.json

Network Access

What Gets Recorded

• HTTP method and full URL, including a path prefix from --target (--target https://api.example.com/v2 records https://api.example.com/v2/users)
• Request headers
• Request body
• Response status code, headers and body

What Gets Redacted

• Headers: Authorization, Proxy-Authorization, Cookie, Set-Cookie, X-Api-Key and Api-Key (for example {{AUTHORIZATION}})
• JSON fields named password, secret, token or apiKey in request and response bodies, including names that end in one of those such as access_token or clientSecret (the value becomes "{{ACCESS_TOKEN}}")

Output Format

### GET /users
# @name get_users

GET https://api.example.com/users
Accept: application/json

>>>
expect status == 200
<<<

### POST /users
# @name post_users

POST https://api.example.com/users
Content-Type: application/json

{
  "name": "John"
}

>>>
expect status == 200
<<<