SwaggerUiHandler

Struct SwaggerUiHandler 

Source
pub struct SwaggerUiHandler { /* private fields */ }
Expand description

Swagger UI 处理器

实现了Silent的Handler trait,可以直接添加到路由中。 负责处理Swagger UI相关的所有请求,包括:

  • Swagger UI 静态资源
  • OpenAPI 规范JSON
  • 重定向到Swagger UI主页

Implementations§

Source§

impl SwaggerUiHandler

Source

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

创建新的Swagger UI处理器

§参数
  • ui_path: Swagger UI的访问路径,如 “/swagger-ui”
  • openapi: OpenAPI规范对象
§示例
use silent_openapi::SwaggerUiHandler;
use utoipa::OpenApi;

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

let handler = SwaggerUiHandler::new("/swagger-ui", ApiDoc::openapi());
Source

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

使用自定义的API文档路径

§参数
  • ui_path: Swagger UI的访问路径
  • api_doc_path: OpenAPI JSON的访问路径
  • openapi: OpenAPI规范对象
Source

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

使用自定义选项创建处理器

Source

pub fn into_route(self) -> Route

将处理器转换为可直接挂载的 Route 树

自动在 <ui_path> 下注册以下路由(GET/HEAD):

  • <ui_path>
  • <ui_path>/openapi.json
  • <ui_path>/<path:**>

Trait Implementations§

Source§

impl Clone for SwaggerUiHandler

Source§

fn clone(&self) -> SwaggerUiHandler

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Handler for SwaggerUiHandler

Source§

fn call<'life0, 'async_trait>( &'life0 self, req: Request, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

impl RouterAdapt for SwaggerUiHandler

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more