Documentation

Getting Started

Everything you need to start using SchemaClient for API development, testing, and debugging.

01 Installation

Download SchemaClient for your platform:

Windows — Download the .msi installer from the download page
macOS — Download the .dmg file (Apple Silicon & Intel supported)
Linux — Download the .AppImage or .deb package

02 Sending API Requests

  1. 1. Open SchemaClient and navigate to the REST Client tab
  2. 2. Enter the API URL in the address bar
  3. 3. Select the HTTP method (GET, POST, PUT, DELETE, etc.)
  4. 4. Add headers, query parameters, or request body as needed
  5. 5. Click Send to execute the request
  6. 6. Inspect the response: status, headers, body, and timing

03 Localhost Tunneling

Expose your local development server to the internet:

  1. 1. Sign in to your SchemaClient account (required for tunneling)
  2. 2. Go to the Tunnel tab
  3. 3. Set the Target URL to your local server (e.g., http://127.0.0.1:8000)
  4. 4. Click Start Tunnel
  5. 5. Your public URL will appear (e.g., https://u1-xxxx.schemaclient.com)

All traffic through the tunnel is visible in the real-time Traffic Monitor below.

04 Traffic Monitoring

The Traffic Monitor shows every HTTP request flowing through your tunnel in real-time:

  • Filter by HTTP method (GET, POST, etc.)
  • Filter by status code (2xx, 4xx, 5xx)
  • Search by path or keyword
  • Click any request to inspect full details

05 Schema Validation

Define expected response structures and validate API responses automatically:

  1. 1. Navigate to the Schema tab
  2. 2. Create a new schema with field definitions
  3. 3. Define expected types, required fields, and constraints
  4. 4. Schemas sync to the cloud when signed in

06 Collections & Cloud Sync

Organize your API requests and sync them across devices:

  • Create collections to group related requests
  • Use folders for hierarchical organization
  • Set base URLs and authentication at the collection level
  • Import from OpenAPI/Swagger specs
  • Sign in to sync collections across devices