Reqjet documentation
Reqjet is an API client for Windows, macOS and Linux. Your requests are saved as plain .http files in folders on
disk, in the format Visual Studio, VS Code REST Client and JetBrains IDEs also read, so they can live in your
repository next to your code. The same files run in the app and on the command line, so the requests you click
through are the ones your CI pipeline checks.
Getting started
Section titled “Getting started”Install ReqjetDownload it for Windows, macOS or Linux, and get past the first-run checks.
Your first requestOpen a folder, write a request, send it and read the response.
Folders and workspacesHow requests are organised on disk, and switching between apps.
Environments and variablesSend the same requests to dev, staging and production, and keep secrets out of git.
Try the samplesDownload ready-made requests that run against free public APIs.
Writing requests
Section titled “Writing requests”Signing inOAuth 2.0, Basic, Digest, AWS Signature V4 and Windows sign-in.
CertificatesClient certificates (mTLS), and self-signed servers.
ProxiesThe system proxy, a manual one, or none.
WebSockets and SSELive connections, from the same .http files.
GraphQLQueries and mutations, with variables.
Responses
Section titled “Responses”Reading a responseThe response tabs, filtering JSON, copying and saving.
History and comparingCompare with earlier responses, or another environment.
DebuggingTiming, TLS, tokens, cookies, redirects, CORS and HAR files.
Testing
Section titled “Testing”TestsHow tests work, and how the checks you make in the app become your CI tests.
Assertions and snapshotsTurn responses into tests without writing code.
OpenAPI contract checksCheck every response against your OpenAPI description.
Data-driven runsRun the same requests once per row of a CSV or JSON file.
Automating
Section titled “Automating”Request scriptsJavaScript before a request and after its response.
RunbooksMarkdown documents with a Run button on every step.
Script filesSend saved requests by name, with logic between them.
Mock serverServe saved responses on localhost.
Quick load testSee how one endpoint copes under load.
Importing and finding
Section titled “Importing and finding”ImportingFrom cURL, OpenAPI, Postman, Insomnia and browser recordings.
Copy as codecurl, C#, JavaScript, Python, Go, Java, PowerShell and k6.
Finding thingsGo to a request, the command palette, and search in files.
TroubleshootingFixes for common problems, and reporting one.
SecurityWhat scripts can do, and how your secrets stay yours.
Reference
Section titled “Reference”.http syntaxEverything a request file can contain.
DirectivesThe # @ comment lines that name, configure and test requests.
Built-in variablesRandom values, timestamps, process variables and tokens.
Command linereqjet run, load and mock, with every option.
Keyboard shortcutsEvery shortcut, on Windows, Linux and macOS.
Settings and filesPreferences, and where Reqjet keeps its settings and logs.