ohkami_openapi 0.24.9

OpenAPI types for Ohkami - A performant, declarative, and runtime-flexible web framework for Rust
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
83
84
85
86
87
88
89
90

#![cfg(test)]

use super::*;
use serde_json::json;

macro_rules! assert_eq {
    ($left:expr, $right:expr) => {{
        let (left, right) = ($left, $right);
        if $left != $right {
            panic!(
                "\
                \n[left]\n\
                {left:#?}\n\
                \n[right]\n\
                {right:#?}\n\
            "
            )
        }
    }};
}

#[test]
fn test_openapi_doc_serialization() {
    let doc = document::Document::new(
        "Sample API", "0.1.9", [
            document::Server::at("http://api.example.com/v1")
                .description("Optional server description, e.g. Main (production) server"),
            document::Server::at("http://staging-api.example.com")
                .description("Optional server description, e.g. Internal staging server for testing")
        ]
    )
    .description("Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.")
    .path("/users", paths::Operations::new()
        .get(
            Operation::with(
                Responses::new([(
                    200, Response::when("A JSON array of user names")
                        .content("application/json", array(string()))
                )])
            )
            .summary("Returns a list of users.")
            .description("Optional extended description in CommonMark or HTML.")
        )
    );

    assert_eq!(
        serde_json::to_value(&doc).unwrap(),
        json!({
            "openapi": "3.1.0",
            "info": {
                "title": "Sample API",
                "description": "Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.",
                "version": "0.1.9"
            },
            "servers": [
                {
                    "url": "http://api.example.com/v1",
                    "description": "Optional server description, e.g. Main (production) server"
                },
                {
                    "url": "http://staging-api.example.com",
                    "description": "Optional server description, e.g. Internal staging server for testing"
                }
            ],
            "paths": {
                "/users": {
                    "get": {
                        "summary": "Returns a list of users.",
                        "description": "Optional extended description in CommonMark or HTML.",
                        "responses": {
                            "200": {
                                "description": "A JSON array of user names",
                                "content": {
                                    "application/json": {
                                        "schema": {
                                            "type": "array",
                                            "items": {
                                                "type": "string"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        })
    );
}