mockforge-sdk 0.3.115

Developer SDK for embedding MockForge in tests and applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//! Pillars: [`DevX`]
//!
//! # `MockForge` SDK
//!
//! Developer SDK for embedding `MockForge` mock servers directly in unit and integration tests.
//!
//! ## Features
//!
//! - **Start/Stop Mock Servers**: Programmatically control mock server lifecycle
//! - **Stub Responses**: Define mock responses with a fluent API
//! - **Offline Mode**: Works without network dependencies
//! - **Multi-Protocol**: HTTP, WebSocket, gRPC, GraphQL support
//! - **Ergonomic API**: Builder pattern for easy configuration
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use mockforge_sdk::MockServer;
//! use serde_json::json;
//!
//! #[tokio::test]
//! async fn test_user_api() {
//!     // Start a mock server
//!     let mut server = MockServer::new()
//!         .port(3000)
//!         .start()
//!         .await
//!         .expect("Failed to start server");
//!
//!     // Stub a response
//!     server
//!         .stub_response("GET", "/api/users/{id}", json!({
//!             "id": "{{uuid}}",
//!             "name": "{{faker.name}}",
//!             "email": "{{faker.email}}"
//!         }))
//!         .await
//!         .expect("Failed to stub response");
//!
//!     // Make requests to the mock server
//!     let client = reqwest::Client::new();
//!     let response = client
//!         .get("http://localhost:3000/api/users/123")
//!         .send()
//!         .await
//!         .expect("Failed to make request");
//!
//!     assert_eq!(response.status(), 200);
//!
//!     // Stop the server
//!     server.stop().await.expect("Failed to stop server");
//! }
//! ```

pub mod admin;
pub mod builder;
pub mod conformance;
pub mod error;
pub mod ffi;
pub mod server;
pub mod stub;
pub mod verification;

pub use admin::{
    AdminClient, MockConfig as AdminMockConfig, MockConfigBuilder, MockList,
    MockResponse as AdminMockResponse, RequestMatchCriteria, ServerConfig as AdminServerConfig,
    ServerStats,
};
pub use builder::MockServerBuilder;
pub use conformance::{ConformanceClient, ConformanceRun, ConformanceRunRequest, RunStatus};
pub use error::{Error, Result};
pub use server::MockServer;
pub use stub::{
    DynamicResponseFn, DynamicStub, RequestContext, ResourceIdExtractConfig, ResponseStub,
    StateMachineConfig, StateResponseOverride, StubBuilder, StubFaultInjectionConfig,
};
pub use verification::Verification;

// Re-export commonly used types from mockforge-core
pub use mockforge_core::{
    Config, FailureConfig, LatencyProfile, OpenApiSpec, ProxyConfig, ServerConfig,
};