Struct OpenApiExpectation 

pub struct OpenApiExpectation {
    pub spec_url_or_payload: String,
    pub operations_and_responses: Option<HashMap<String, String>>,
    pub context_path_prefix: Option<String>,
}

An OpenAPI specification import — registers matchers and example responses for the operations in an OpenAPI/Swagger spec.

Sent via PUT /mockserver/openapi. The spec may be a URL, a filesystem path (file://...), a classpath resource, or an inline JSON/YAML payload.

Example

use mockserver_client::OpenApiExpectation;

let expectation = OpenApiExpectation::new(
    "https://example.com/petstore.yaml",
)
.operation("listPets", "200")
.operation("showPetById", "200");

Fields

spec_url_or_payload: String

operations_and_responses: Option<HashMap<String, String>>

context_path_prefix: Option<String>

Implementations

impl OpenApiExpectation

pub fn new(spec_url_or_payload: impl Into<String>) -> Self

Create an OpenAPI import from a spec URL, file path, classpath resource, or inline JSON/YAML payload.

pub fn operation( self, operation_id: impl Into<String>, status_code: impl Into<String>, ) -> Self

Map an operationId to the status code (or example name) to respond with.

When no operations are specified, MockServer creates example responses for every operation in the spec.

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

Replace the full operations-to-responses map.

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

Set a context-path prefix to prepend to every generated matcher path.

Trait Implementations

impl Clone for OpenApiExpectation

fn clone(&self) -> OpenApiExpectation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenApiExpectation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenApiExpectation

fn default() -> OpenApiExpectation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenApiExpectation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OpenApiExpectation

fn eq(&self, other: &OpenApiExpectation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OpenApiExpectation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenApiExpectation