Trait poem_openapi::OpenApi

pub trait OpenApi: Sized {
    // Required methods
    fn meta() -> Vec<MetaApi>;
    fn register(registry: &mut Registry);
    fn add_routes(
        self,
        route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>>
    );
}

Represents a OpenAPI object.

Required Methods

fn meta() -> Vec<MetaApi>

Gets metadata of this API object.

fn register(registry: &mut Registry)

Register some types to the registry.

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

Adds all API endpoints to the routing object.

Implementations on Foreign Types

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi> OpenApi for (T1, T2, T3, T4, T5)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl OpenApi for ()

fn meta() -> Vec<MetaApi>

fn register(_registry: &mut Registry)

fn add_routes( self, _route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi> OpenApi for (T1, T2)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi, T8: OpenApi, T9: OpenApi, T10: OpenApi, T11: OpenApi, T12: OpenApi, T13: OpenApi, T14: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi, T8: OpenApi, T9: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7, T8, T9)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi, T8: OpenApi, T9: OpenApi, T10: OpenApi, T11: OpenApi, T12: OpenApi, T13: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi, T8: OpenApi, T9: OpenApi, T10: OpenApi, T11: OpenApi, T12: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi, T8: OpenApi, T9: OpenApi, T10: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi, T8: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7, T8)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi, T8: OpenApi, T9: OpenApi, T10: OpenApi, T11: OpenApi, T12: OpenApi, T13: OpenApi, T14: OpenApi, T15: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi, T8: OpenApi, T9: OpenApi, T10: OpenApi, T11: OpenApi, T12: OpenApi, T13: OpenApi, T14: OpenApi, T15: OpenApi, T16: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi, T8: OpenApi, T9: OpenApi, T10: OpenApi, T11: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi> OpenApi for (T1, T2, T3, T4)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi, T4: OpenApi, T5: OpenApi, T6: OpenApi, T7: OpenApi> OpenApi for (T1, T2, T3, T4, T5, T6, T7)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

impl<T1: OpenApi, T2: OpenApi, T3: OpenApi> OpenApi for (T1, T2, T3)

fn meta() -> Vec<MetaApi>

fn register(registry: &mut Registry)

fn add_routes( self, route_table: &mut HashMap<String, HashMap<Method, BoxEndpoint<'static>>> )

Implementors