Struct SwaggerUiMiddleware 

pub struct SwaggerUiMiddleware { /* private fields */ }

Swagger UI 中间件

实现了Silent的MiddleWareHandler trait，可以作为中间件添加到路由中。 当请求匹配Swagger UI相关路径时，直接返回响应；否则继续执行后续处理器。

Implementations

impl SwaggerUiMiddleware

pub fn new(ui_path: &str, openapi: OpenApi) -> Result<Self>

创建新的Swagger UI中间件

参数

• ui_path: Swagger UI的访问路径，如 “/swagger-ui”
• openapi: OpenAPI规范对象

示例

use silent::prelude::*;
use silent_openapi::SwaggerUiMiddleware;
use utoipa::OpenApi;

#[derive(OpenApi)]
#[openapi(paths(), components(schemas()))]
struct ApiDoc;

let middleware = SwaggerUiMiddleware::new("/swagger-ui", ApiDoc::openapi());

let route = Route::new("")
    .hook(middleware)
    .get(your_handler);

pub fn with_custom_api_doc_path( ui_path: &str, api_doc_path: &str, openapi: OpenApi, ) -> Result<Self>

使用自定义的API文档路径

pub fn with_options( ui_path: &str, openapi: OpenApi, options: SwaggerUiOptions, ) -> Result<Self>

使用自定义选项创建中间件

Trait Implementations

impl Clone for SwaggerUiMiddleware

fn clone(&self) -> SwaggerUiMiddleware

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl MiddleWareHandler for SwaggerUiMiddleware

fn handle<'life0, 'life1, 'async_trait>( &'life0 self, req: Request, next: &'life1 Next, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

处理请求：命中 Swagger 相关路径则拦截返回，否则交由下一个处理器