clawspec-core 0.4.4

Core library for generating OpenAPI specifications from tests
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

#![allow(dead_code)]

use clawspec_core::{ApiClient, CallPath, ParamValue};
use http::uri::Scheme;
use serde::Deserialize;
use utoipa::ToSchema;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    tracing_subscriber::fmt().pretty().init();

    // Create a client
    let mut client = ApiClient::builder()
        .with_scheme(Scheme::HTTP)
        .with_host("dog.ceo")
        .with_base_path("/api")?
        .build()?;

    // Simple get call with no parameters
    let _result = client
        .get("/breeds/list")?
        .await?
        .as_json::<BreedsList>()
        .await?;

    // Get call with a parameter
    let path = CallPath::from("/breed/{breed}/images").add_param("breed", ParamValue::new("hound"));

    let _result = client.get(path)?.await?.as_json::<BreedImages>().await?;

    // extract collected data from client
    let paths = client.collected_openapi().await;
    let out = serde_saphyr::to_string(&paths).expect("YAML serialization");
    println!("{out}");

    Ok(())
}

type BreedsList = DogCeoResult<Vec<String>>;

type BreedImages = DogCeoResult<Vec<String>>;

#[derive(Debug, Clone, Deserialize, ToSchema)]
#[serde(tag = "status", rename_all = "lowercase")]
enum DogCeoResult<T> {
    Success { message: T },
    Error { code: u16, message: String },
}