oas_gen 0.5.0

An ergonomic, opinionated, builder pattern based api to build simple Open Api v3 specs in json for REST apis.
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

use serde::{Deserialize, Serialize};
use serde_json::Value;
use serde_skip::is_default;
use std::collections::BTreeMap as Map;

/// The test in the "x-tests" extension.
/// Implementation is based on 8c84cc6 of <https://github.com/davidkpiano/openapi-test>
#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct Test {
    /// The description of the test, used for reporting the test results.
    pub description: String,
    #[serde(skip_serializing_if = "is_default", default)]
    /// Whether to add the --token JWT to the header and authorize the request (default: false).
    pub auth: bool,
    #[serde(skip_serializing_if = "is_default", default)]
    /// If true, this test will be skipped. (default: false).
    pub skip: bool,
    #[serde(skip_serializing_if = "is_default", default)]
    /// (optional) Supplies dynamic parameter values (e.g., "name": ... would supply the value for /{name} in the path). Only needed for tests with URL params.
    pub params: Map<String, String>,
    #[serde(skip_serializing_if = "is_default", default)]
    /// An object that contains:
    /// query
    pub request: Request,
    #[serde(skip_serializing_if = "is_default", default)]
    /// An object that contains:
    /// status
    pub response: Response,

    #[serde(skip_serializing_if = "is_default", default)]
    pub required: Vec<String>,
}

#[derive(Debug, Default, Serialize, Deserialize, PartialEq, Clone)]
pub struct Request {
    #[serde(skip_serializing_if = "is_default", default)]
    pub body: Value,
    #[serde(skip_serializing_if = "is_default", default)]
    pub cookie: String,
    #[serde(skip_serializing_if = "is_default", default)]
    pub headers: Map<String, String>,
    #[serde(skip_serializing_if = "is_default", default)]
    /// (optional) - A mapping of query parameter keys to their values (e.g., "format": "json" will append ?format=json to the URL)
    pub query: Map<String, String>,
}

#[derive(Debug, Default, Serialize, Deserialize, PartialEq, Clone)]
pub struct Response {
    #[serde(skip_serializing_if = "is_default", default)]
    pub cookie: Map<String, String>,
    #[serde(skip_serializing_if = "is_default", default)]
    pub headers: Map<String, String>,
    #[serde(skip_serializing_if = "is_default", default)]
    /// A status code (e.g., 200) or array of status codes (e.g., [200, 301]) that the expected response should match
    pub status: Vec<u16>,
}