HTTP request and diff tools
There're two separate CLIs provided:
- xdiff: A diff tool for comparing HTTP requests. It could be used to compare the difference between production staging or two versions of the same API.
- xreq: A tool to build HTTP requests based on predefined profiles. It could be used to replace curl/httpie for building complicated HTTP requests.
xdiff
Configuration
You can configure multiple profiles for xdiff. Each profile is identified by a name. Inside a profile you can define the details of the two requests (method, url, query params, request headers, request body), and also what part of the response should be skipped for comparison (currently only headers could be skipped).
---
rust:
request1:
method: GET
url: https://www.rust-lang.org/
headers:
user-agent: Aloha
params:
hello: world
request2:
method: GET
url: https://www.rust-lang.org/
params:
response:
skip_headers:
- set-cookie
- date
- via
- x-amz-cf-id
You could put the configuration in ~/.config/xdiff.yml
, or /etc/xdiff.yml
, or ~/xdiff.yml
. The xdiff CLI will look for configuration from these paths.
How to use xdiff?
You can use cargo install xdiff
to install it (need help to install rust toolchain?). Once finished you shall be able to use it.
)
An example:
This will use the todo profile in the diff.yml defined in requester/fixtures
, and add extra params for query string with a=1, b=2. Output look like this:
If you find writing the config file tedious, you can use the xdiff parse
subcommand to parse a URL and print the generated config.
xreq
since xdiff needs to send and format request so this logic was extracted as a separate CLI xreq
.
Configuration
You can configure multiple profiles for xreq. Each profile is identified by a name. Inside a profile you can define the details of the request (method, url, query params, request headers, request body).
---
rust:
url: https://www.rust-lang.org/
post:
url: https://jsonplaceholder.typicode.com/comments
params:
postId: 1
You could put the configuration in ~/.config/xreq.yml
, or /etc/xreq.yml
, or ~/xreq.yml
. The xreq CLI will look for configuration from these paths.
How to use xreq?
You can use cargo install xreq
to install it. Once finished you shall be able to use it.
for; ;
)
An example:
This will use the todo profile in the req.yml defined in requester/fixtures
, and add extra params for query string with a=1, b=2. Output look like this:
You could also use tools like jq
to process its output. When xreq detected a pipe, it will skip printing status/headers, and skip the colorized format on http body. For example:
|
Output:
If you find writing the config file tedious, you can use the xreq parse
subcommand to parse a URL and print the generated config.
&b=2