Skip to main content

​
Agent-native across 6 coding tools, visual debugger, fast CLI, your entire API lives in plain markdown.

Reqbook stores API work as plain markdown files. Send ad-hoc requests from the terminal or browser. Design API contracts. Validate them in CI. Your coding agent can read, write, and run everything. No hosted workspace, no proprietary format just files in your repo.

rqb-cli

Terminal interface: rqb request, rqb exec, rqb flow, and more.

rqb-ui

Browser interface: New Request panel, endpoint runner, flow canvas.

Agent integration

MCP tools and skills for Claude Code, Cursor, Copilot, and others.

Quickstart

Install Reqbook, create a project, and execute your first request in under five minutes.

Agent integration

Install skills and MCP tools so Claude Code, Cursor, Copilot, and others can work with specs directly.

Web preview

Browse specs, tune parameters, send requests, inspect responses, and edit markdown all in the browser.

Vibe coding guide

Use Reqbook in your agent loop: document routes, run endpoints, build flows, and review changes.

​
How it works

Every API operation lives in a markdown file: 
api-docs/
├── reqbook.md # Project config and defaults
├── _shared/
│ ├── env.template.md # Shared environment template
│ └── env.md # Local environment values
├── apis/
│ ├── users/
│ │ ├── get-user-by-id.md
│ │ └── create-user.md
│ └── orders/
│ └── post-orders.md
└── flows/
 └── checkout.md # Multi-step pipeline
The same files are used by:
SurfaceWhat it does
rqb execSends the HTTP request and diffs the response
rqb serveRenders a browser UI for interactive testing
rqb mockServes recorded responses without a live backend
rqb flowRuns a pipeline, captures values, injects them into later steps
Agent skillsTeaches agents the format, file layout, and how to validate changes
MCP toolsLets compatible agents search, execute, author, and summarize specs without shell parsing
CIValidates all specs and exits non-zero on any failure

​
The vibe coding loop

1

Agent creates or updates specs

Ask your agent to document a route, import from curl, or scan the project for missing specs:
Scan this project for API routes and add missing Reqbook specs.

Document POST /orders and make it runnable in Reqbook.
2

Review in the browser UI

rqb serve
# → Preview: http://127.0.0.1:8080
Inspect the generated markdown, adjust runtime params, run the request, and compare the response against the expected value.
3

Build flows

Ask the agent to connect specs into a pipeline:
Create a checkout flow: create customer → create order, capture orderId → fetch order.
The flow is saved as api-docs/flows/checkout.md and runnable from both CLI and browser.
4

Commit reviewable markdown

rqb validate api-docs/
Specs are ordinary markdown. Every change is reviewable, diffable, and revertable in your PR.

​
Without Reqbook, agents work blind

When an agent needs to test an API endpoint without Reqbook, it reads router files, middleware, env config, constructs a curl command, parses raw stdout, and throws everything away. The next session starts from zero.
TaskWithout ReqbookWith Reqbook
Test one endpointRead source files, construct curl, parse stdoutrqb_exec spec.md structured result
Diagnose an endpoint failureSearch logs and handlers manuallyrqb_diagnose spec.md likely cause, inspect targets, and verify commands
Debug multi-step flowWrite a temp script, manually chain requests, no trace on failurerqb_flow pipeline.md per-step state, captured values
Detect a regressionOnly after a bug reportrqb check or rqb validate in CI fails before merge
Agent discovers APIsScan broad source and docs manuallyrqb context and rqb_search return bounded API context
Share tests with team”Send me the curl”Commit markdown, review in PR
Mock backendRun live server or hardcoderqb mock from recorded responses
The setup cost is five minutes (rqb init). After that, API docs, tests, CI checks, mock responses, and agent context come from the same reviewable markdown files.

​
Why not Postman, Insomnia, Bruno, or Hurl?

Agents need file-based tools

GUI tools store state in app databases or proprietary formats. Agents cannot read or write them reliably. Reqbook specs are plain markdown any agent can read, create, and edit them.

Everything stays in the repo

Specs live in api-docs/ alongside your code. Every API change goes through code review. No “export to share” step, no drift between the tool and the repo.

One source, every surface

The same file runs in the CLI, renders in the browser UI, serves the mock server, and validates in CI. You describe the API once.

No account, no cloud

A single Rust binary. No signup, no workspace ID, no internet dependency at runtime. Works offline.
Postman is the right choice when a team wants a broad hosted API platform with collaboration, monitoring, and governance. Bruno is the right choice when a team primarily wants a mature Git-native desktop API client. Hurl is the right choice when a team wants a fast plain-text HTTP test runner in CI. Reqbook is for teams that want API docs in the repo to be readable, executable, reviewable in PRs, runnable in CI, and directly usable by coding agents.

​
Next steps

Quickstart

Run a real API request in five minutes.

Set up agents

Install skills, slash commands, and MCP for supported coding agents.

Web preview

Start rqb serve and explore the browser UI.