https://github.com/alexliesenfeld/httpmock
HTTP mocking library for Rust
https://github.com/alexliesenfeld/httpmock
http-mocking mock mock-server rust test test-framework
Last synced: 6 months ago
JSON representation
HTTP mocking library for Rust
- Host: GitHub
- URL: https://github.com/alexliesenfeld/httpmock
- Owner: alexliesenfeld
- License: mit
- Created: 2019-09-09T10:55:45.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-05-07T11:04:44.000Z (6 months ago)
- Last Synced: 2025-05-07T12:22:56.025Z (6 months ago)
- Topics: http-mocking, mock, mock-server, rust, test, test-framework
- Language: Rust
- Homepage: https://httpmock.rs
- Size: 3.52 MB
- Stars: 587
- Watchers: 3
- Forks: 51
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-rust - httpmock
- awesome-rust - httpmock
- awesome-rust-cn - httpmock
- awesome-rust - httpmock - HTTP mocking [](https://dev.azure.com/alexliesenfeld/httpmock/_build/latest?definitionId=2&branchName=master) (Development tools / Testing)
- fucking-awesome-rust - httpmock - HTTP mocking [](https://dev.azure.com/alexliesenfeld/httpmock/_build/latest?definitionId=2&branchName=master) (Development tools / Testing)
- fucking-awesome-rust - httpmock - HTTP mocking [](https://dev.azure.com/alexliesenfeld/httpmock/_build/latest?definitionId=2&branchName=master) (Development tools / Testing)
README
Simple yet powerful HTTP mocking library for Rust
[](https://github.com/alexliesenfeld/httpmock/actions/workflows/build.yml)
[](https://crates.io/crates/httpmock)
[](https://github.com/rust-unofficial/awesome-rust#testing)
[](https://github.com/rust-lang/rust/blob/master/RELEASES.md#version-1700-2023-06-01)
Website
·
API Reference
·
Forum
·
Crate
·
Report Bug
·
Request Feature
·
Support this Project
## Features
* Mocks responses from HTTP services
* Simple, expressive, fluent API.
* Many built-in helpers for easy request matching ([Regex](https://docs.rs/regex/), JSON, [serde](https://crates.io/crates/serde), cookies, and more).
* Record and Playback third-party services
* Forward and Proxy Mode
* HTTPS support
* Fault and network delay simulation.
* Custom request matchers.
* Standalone mode with an accompanying [Docker image](https://hub.docker.com/r/alexliesenfeld/httpmock).
* Helpful error messages
* [Advanced verification and debugging support](https://alexliesenfeld.github.io/posts/mocking-http--services-in-rust/#creating-mocks) (including diff generation between actual and expected HTTP request values)
* Parallel test execution.
* Fully asynchronous core with synchronous and asynchronous APIs.
* Support for [mock configuration using YAML files](https://github.com/alexliesenfeld/httpmock/tree/master#file-based-mock-specification).
## Getting Started
Add `httpmock` to `Cargo.toml`:
```toml
[dev-dependencies]
httpmock = "0.8.0-alpha.1"
```
You can then use `httpmock` as follows:
```rust
use httpmock::prelude::*;
// Start a lightweight mock server.
let server = MockServer::start();
// Create a mock on the server.
let mock = server.mock(|when, then| {
when.method(GET)
.path("/translate")
.query_param("word", "hello");
then.status(200)
.header("content-type", "text/html; charset=UTF-8")
.body("hola");
});
// Send an HTTP request to the mock server. This simulates your code.
let response = isahc::get(server.url("/translate?word=hello")).unwrap();
// Ensure the specified mock was called exactly one time (or fail with a
// detailed error description).
mock.assert();
// Ensure the mock server did respond as specified.
assert_eq!(response.status(), 200);
```
The above example will spin up a lightweight HTTP mock server and configure it to respond to all `GET` requests
to path `/translate` with query parameter `word=hello`. The corresponding HTTP response will contain the text body
`hola`.
When the specified expectations do not match the received request, `mock.assert()` fails the test with a detailed error description,
including a diff that shows the differences between the expected and actual HTTP requests. Example:
```bash
0 of 1 expected requests matched the mock specification.
Here is a comparison with the most similar unmatched request (request number 1):
------------------------------------------------------------
1 : Query Parameter Mismatch
------------------------------------------------------------
Expected:
key [equals] word
value [equals] hello-rustaceans
Received (most similar query parameter):
word=hello
All received query parameter values:
1. word=hello
Matcher: query_param
Docs: https://docs.rs/httpmock/0.8.0-alpha.1/httpmock/struct.When.html#method.query_param
```
# Usage
See the [official website](http://httpmock.rs) for detailed API documentation.
## Examples
You can find examples in the
[`httpmock` test directory](https://github.com/alexliesenfeld/httpmock/blob/master/tests/).
The [official website](http://httpmock.rs) and [reference docs](https://docs.rs/httpmock/) also contain _**a lot**_ of examples.
## License
`httpmock` is free software: you can redistribute it and/or modify it under the terms of the MIT Public License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MIT Public License for more details.