HttpProbe Documentation

A powerful HTTP API testing tool for defining, running, and validating API tests using YAML or JSON test definitions.

Get started now View it on GitHub

Overview

HttpProbe makes API testing simple and powerful by allowing you to define tests using YAML or JSON files. It supports:

  • Variable interpolation for dynamic test data
  • Comprehensive assertions for status codes, headers, and response bodies
  • Schema validation for verifying response structures
  • Multiple output formats for results visualization
  • Parallel execution for faster test runs

Getting Started

Installation

Linux & macOS (Install Script)

Use the install script to automatically download and install the appropriate version:

curl -sSL https://raw.githubusercontent.com/mrfoh/httpprobe/main/install.sh | bash

macOS (Homebrew) 

# Add the tap
brew tap mrfoh/tap

# Install httpprobe
brew install httpprobe

Linux (Snap) 

# Install httpprobe
sudo snap install httpprobe

Windows (Scoop) 

# Add the bucket
scoop bucket add mrfoh https://github.com/mrfoh/scoopbucket

# Install httpprobe
scoop install mrfoh/httpprobe

From Binary Releases

Download the prebuilt binary for your platform from the releases page.

  1. Choose the appropriate archive for your platform:
    • Linux: httpprobe-v{version}_linux_{arch}.tar.gz
    • macOS: httpprobe-v{version}_darwin_{arch}.tar.gz
    • Windows: httpprobe-v{version}_windows_{arch}.tar.gz
  2. Extract the archive and place the binary in your PATH.

From Source 

# Clone the repository
git clone https://github.com/mrfoh/httpprobe.git
cd httpprobe

# Build the binary
go build -o httpprobe ./cmd/main.go

# Move the binary to somewhere in your PATH (Linux/macOS)
sudo mv httpprobe /usr/local/bin/

Using Go Install

If you have Go installed, you can install directly:

go install github.com/mrfoh/httpprobe@latest

Basic Usage

  1. Create a test definition file named simple.test.yaml:
name: "Simple API Test"
description: "Testing a simple API endpoint"
variables:
  base_url:
    type: string
    value: "https://api.example.com"
suites:
  - name: "Basic Tests"
    cases:
      - title: "Get Users"
        request:
          method: GET
          url: "${base_url}/users"
          headers:
            - key: Accept
              value: application/json
          assertions:
            status: 200
  1. Run your test:
httpprobe run

Example Test Output 

Simple API Test: simple.test.yaml
  Suite: Basic Tests
    Get Users (124.56 ms): PASS

Test Suites: 1 passed, 1 total
Test Cases: 1 passed, 1 total
Total time: 124.56 ms

Why HttpProbe?

  • Declarative tests - Focus on what to test, not how to test it
  • Reusable variables - Define once, use across multiple test cases
  • Powerful assertions - Validate complex responses with ease
  • Detailed failure reporting - Quickly understand what went wrong
  • Flexible execution - Run tests in sequence or in parallel

Next Steps

Explore the detailed documentation: