Struct MockConfigBuilder 

pub struct MockConfigBuilder { /* private fields */ }

Builder for creating mock configurations with fluent API

This builder provides a WireMock-like fluent API for creating mock configurations with comprehensive request matching and response configuration.

Examples

use mockforge_sdk::admin::MockConfigBuilder;
use serde_json::json;

// Basic mock
let mock = MockConfigBuilder::new("GET", "/api/users")
    .name("Get Users")
    .status(200)
    .body(json!([{"id": 1, "name": "Alice"}]))
    .build();

// Advanced matching with headers and query params
let mock = MockConfigBuilder::new("POST", "/api/users")
    .name("Create User")
    .with_header("Authorization", "Bearer.*")
    .with_query_param("role", "admin")
    .with_body_pattern(r#"{"name":".*"}"#)
    .status(201)
    .body(json!({"id": 123, "created": true}))
    .priority(10)
    .build();

Implementations

impl MockConfigBuilder

pub fn new(method: impl Into<String>, path: impl Into<String>) -> Self

Create a new mock configuration builder

Arguments

• method - HTTP method (GET, POST, PUT, DELETE, etc.)
• path - URL path pattern (supports path parameters like /users/{id})

pub fn id(self, id: impl Into<String>) -> Self

Set the mock ID

pub fn name(self, name: impl Into<String>) -> Self

Set the mock name

pub fn body(self, body: Value) -> Self

Set the response body (supports templating with {{variables}})

pub fn status(self, status: u16) -> Self

Set the response status code

pub fn headers(self, headers: HashMap<String, String>) -> Self

Set response headers

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a single response header

pub fn latency_ms(self, ms: u64) -> Self

Set the latency in milliseconds

pub fn enabled(self, enabled: bool) -> Self

Enable or disable the mock

pub fn with_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Require a specific header to be present and match (supports regex patterns)

Examples

MockConfigBuilder::new("GET", "/api/users")
    .with_header("Authorization", "Bearer.*")
    .with_header("Content-Type", "application/json")

pub fn with_headers(self, headers: HashMap<String, String>) -> Self

Require multiple headers to be present and match

pub fn with_query_param( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Require a specific query parameter to be present and match

Examples

MockConfigBuilder::new("GET", "/api/users")
    .with_query_param("role", "admin")
    .with_query_param("limit", "10")

pub fn with_query_params(self, params: HashMap<String, String>) -> Self

Require multiple query parameters to be present and match

pub fn with_body_pattern(self, pattern: impl Into<String>) -> Self

Require the request body to match a pattern (supports exact match or regex)

Examples

MockConfigBuilder::new("POST", "/api/users")
    .with_body_pattern(r#"{"name":".*"}"#)  // Regex pattern
    .with_body_pattern("exact string match")  // Exact match

pub fn with_json_path(self, json_path: impl Into<String>) -> Self

Require the request body to match a JSONPath expression

Examples

MockConfigBuilder::new("POST", "/api/users")
    .with_json_path("$.name")  // Body must have a 'name' field
    .with_json_path("$.age > 18")  // Body must have age > 18

pub fn with_xpath(self, xpath: impl Into<String>) -> Self

Require the request body to match an XPath expression (for XML)

Examples

MockConfigBuilder::new("POST", "/api/users")
    .with_xpath("/users/user[@id='123']")

pub fn with_custom_matcher(self, expression: impl Into<String>) -> Self

Set a custom matcher expression for advanced matching logic

Examples

MockConfigBuilder::new("GET", "/api/users")
    .with_custom_matcher("headers.content-type == \"application/json\"")
    .with_custom_matcher("path =~ \"/api/.*\"")

pub fn priority(self, priority: i32) -> Self

Set the priority for this mock (higher priority mocks are matched first)

Default priority is 0. Higher numbers = higher priority.

pub fn scenario(self, scenario: impl Into<String>) -> Self

Set the scenario name for stateful mocking

Scenarios allow you to create stateful mock sequences where the response depends on previous requests.

pub fn when_scenario_state(self, state: impl Into<String>) -> Self

Require a specific scenario state for this mock to be active

This mock will only match if the scenario is in the specified state.

pub fn will_set_scenario_state(self, state: impl Into<String>) -> Self

Set the new scenario state after this mock is matched

After this mock responds, the scenario will transition to this state.

pub fn build(self) -> MockConfig

Build the mock configuration