api-quick Documentation

api-quick is a high-performance, multi-interface HTTP engine, static code analysis sniffer, and API workbench designed for modern software engineers and CI/CD pipelines.

Core Vision: Bridge the gap between ultra-fast terminal execution (cURL speed) and visual interactive workbenches (Postman / Insomnia) without compromising memory footprint or security.

Installation Guide

Install @skjuve/api-quick globally via NPM or execute instantly via NPX:

Global Installation (Recommended)

npm install -g @skjuve/api-quick

Instant Zero-Installation Execution

npx @skjuve/api-quick web

Quick Start Commands

Command	Description
`api-quick web [--port 4000]`	Launch Web UI Workbench with CORS bypass proxy
`api-quick tui`	Launch full interactive Terminal UI workbench
`api-quick sniff [dir]`	Scan local source code AST for API routes
`api-quick bench <url> -n 100 -c 10`	Run high-throughput HTTP load benchmark
`api-quick mock [--port 8080]`	Launch zero-latency AST mock API server
`api-quick diff <url1> <url2>`	Visual structural JSON diffing engine

Polyglot AST Route Sniffer

api-quick inspects local backend source code statically (without running the application) to discover API routes across 8 major frameworks:

Express.js / Node.js (app.get, router.post, module mount prefixes)
NestJS (@Get, @Post, @Controller)
Next.js (App & Pages Router)
FastAPI & Flask (Python)
Django REST Framework
Go Gin / Fiber
Spring Boot (Java/Kotlin)
Laravel (PHP)

api-quick sniff

E2E Workflow Chaining Engine

Run automated multi-step request sequences with automatic JWT Bearer token capture and variable propagation across dependent steps.

High-Throughput Load Benchmark Engine

Simulate concurrent HTTP worker pools directly from CLI or Web UI to measure requests per second and latency percentiles (p50, p95, p99).

api-quick bench http://localhost:4000/api/v1/auth/me -n 500 -c 20

Zero-Latency Mock Server

Start a virtual Hono API mock server on port 8080 responding to all sniffed AST routes with structured mock JSON data.

api-quick mock --port 8080

Structural JSON Diff Engine

Compare JSON response structures recursively between local and staging/production environments to detect breaking API changes.

api-quick diff http://localhost:4000/api/v1/products https://staging.api.com/v1/products

Code Transpiler (--to)

Transpile live CLI requests into production-ready code in 8 languages:

api-quick POST https://api.stripe.com/v1/charges amount=2000 --to python

CI/CD Assertion DSL

Run zero-dependency automated API assertions in GitHub Actions pipelines with POSIX exit code alignment:

api-quick GET https://api.example.com/health \
  --expect-status 200 \
  --expect-max-time 150ms \
  --expect-json "$.status" = "OK"