Struct SwaggerUi 

pub struct SwaggerUi { /* private fields */ }

Available on crate features openapi and swagger-ui only.

A wrapper around the Swagger UI functionality.

This struct serves the Swagger UI interface for OpenAPI documentation. It can be registered with a Cot application to provide interactive API documentation at a specified URL path.

Example

use cot::openapi::swagger_ui::SwaggerUi;
use cot::project::{AppBuilder, RegisterAppsContext};

fn register_apps(apps: &mut AppBuilder, _context: &RegisterAppsContext) {
    // Register SwaggerUI at the "/swagger" path
    apps.register_with_views(SwaggerUi::new(), "/swagger");
}

Implementations

impl SwaggerUi

pub fn new() -> Self

Creates a new SwaggerUi that serves the OpenAPI JSON at the default path.

pub fn with_api_at<P: Into<Cow<'static, str>>>(openapi_path: P) -> Self

Creates a new SwaggerUi that serves the OpenAPI JSON at the specified path.

Trait Implementations

impl App for SwaggerUi

fn name(&self) -> &'static str

The name of the app.

fn router(&self) -> Router

Returns the router for the app. By default, it returns an empty router.

fn static_files(&self) -> Vec<StaticFile>

Returns a list of static files that the app serves. By default, it returns an empty list.

fn init<'life0, 'life1, 'async_trait>( &'life0 self, context: &'life1 mut ProjectContext, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Initializes the app.

fn migrations(&self) -> Vec<Box<SyncDynMigration>>

Available on crate feature db only.

Returns the migrations for the app. By default, it returns an empty list.

fn admin_model_managers(&self) -> Vec<Box<dyn AdminModelManager>>

Returns the admin model managers for the app. By default, it returns an empty list.

impl Clone for SwaggerUi

fn clone(&self) -> SwaggerUi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SwaggerUi

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SwaggerUi

fn default() -> Self

Returns the “default value” for a type.