Struct DocAssert

pub struct DocAssert<'a> { /* private fields */ }

Builder for the assertions.

The builder is used to configure the assertions.

Examples

use doc_assert::DocAssert;
use doc_assert::Variables;

async fn test() {
    // Create Variables for values that will be shared between requests and responses
    let mut variables = Variables::new();
    variables.insert_string("token".to_string(), "abcd".to_string());
    // Create a DocAssert builder with the base URL and the path to the documentation file
    let mut doc_assert = DocAssert::new()
        .with_url("http://localhost:8080")
        .with_doc_path("path/to/README.md");
    // Execute the assertions
    let report = doc_assert.assert().await;
}

Implementations

impl<'a> DocAssert<'a>

pub fn new() -> Self

Constructs a new, empty DocAssert builder.

The builder is used to configure the assertions.

Examples

use doc_assert::DocAssert;
let mut doc_assert = DocAssert::new();

pub fn with_url(self, url: &'a str) -> Self

Sets the base URL to test against.

The URL will be used to make the requests.

Examples

use doc_assert::DocAssert;
let mut doc_assert = DocAssert::new().with_url("http://localhost:8080");

pub fn with_doc_path(self, doc_path: &'a str) -> Self

Sets the path to the documentation file.

The path will be used to parse the documentation.

Examples

use doc_assert::DocAssert;
let mut doc_assert = DocAssert::new().with_doc_path("path/to/README.md");

pub fn with_variables(self, variables: Variables) -> Self

Sets the variables to be used in the assertions.

The variables will be used to replace the placeholders in the documentation.

Examples

use doc_assert::DocAssert;
use doc_assert::Variables;

let mut variables = Variables::new();
variables.insert_string("token".to_string(), "abcd".to_string());
let mut doc_assert = DocAssert::new().with_variables(variables);

pub async fn assert(self) -> Result<Report, AssertionError>

Execute the assertions

The assertions will be executed and a report will be returned

Examples

use doc_assert::DocAssert;
async fn test() {
    let mut doc_assert = DocAssert::new()
        .with_url("http://localhost:8080")
        .with_doc_path("path/to/README.md");
    match doc_assert.assert().await {
        Ok(report) => {
            // handle success
        }
        Err(err) => {
            // handle error
        }
    };
}

Trait Implementations

impl<'a> Default for DocAssert<'a>

fn default() -> Self

Returns the “default value” for a type.