fastrust 0.3.1

A lightweight API framework built on top of Axum, inspired by FastAPI
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

use super::builder::APIApp;

impl<S> APIApp<S>
where
    S: Clone + Send + Sync + 'static,
{
    /// Generates the Swagger UI HTML page.
    ///
    /// This method creates an HTML page that embeds Swagger UI, configured
    /// to load the OpenAPI specification from the given path. The Swagger
    /// UI provides an interactive interface for exploring and testing API
    /// endpoints.
    ///
    /// # Arguments
    ///
    /// * `openapi_path` - The path to the OpenAPI JSON specification
    ///
    /// # Returns
    ///
    /// A complete HTML document as a string that includes Swagger UI
    /// via CDN and is configured to load the OpenAPI spec from the
    /// specified path.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use fastrust::APIApp;
    ///
    /// let html = APIApp::<()>::swagger_html("/openapi.json");
    /// assert!(html.contains("Swagger UI"));
    /// ```
    pub fn swagger_html(openapi_path: &str) -> String {
        format!(
            r#"<!DOCTYPE html>
<html>
<head>
    <title>Swagger UI</title>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css" />
    <style>
        body {{ margin: 0; padding: 0; }}
    </style>
</head>
<body>
    <div id="swagger-ui"></div>
    <script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
    <script>
        window.onload = function() {{
            SwaggerUIBundle({{
                url: "{openapi_path}",
                dom_id: '#swagger-ui',
                presets: [
                    SwaggerUIBundle.presets.apis,
                    SwaggerUIBundle.SwaggerUIStandalonePreset
                ],
                layout: "BaseLayout",
                deepLinking: true
            }});
        }};
    </script>
</body>
</html>"#
        )
    }
}