Trait poem_openapi::OpenApi[−][src]

pub trait OpenApi: Sized {
    fn meta() -> Vec<MetaApi>ⓘNotable traits for Vec<u8, A>
impl<A> Write for Vec<u8, A> where
    A: Allocator, ;
    fn register(registry: &mut Registry);
    fn add_routes(self, route: Route) -> Route;

    fn combine<T: OpenApi>(self, other: T) -> CombinedAPI<Self, T> { ... }
}

Expand description

Represents a OpenAPI object.

Required methods

fn meta() -> Vec<MetaApi>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

Gets metadata of this API object.

fn register(registry: &mut Registry)

Register some types to the registry.

fn add_routes(self, route: Route) -> Route

Adds all API endpoints to the routing object.

Provided methods

fn combine<T: OpenApi>(self, other: T) -> CombinedAPI<Self, T>

Combine two API objects into one.

Implementations on Foreign Types

impl OpenApi for ()

fn meta() -> Vec<MetaApi>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn register(_registry: &mut Registry)

fn add_routes(self, route: Route) -> Route

Implementors

impl<A: OpenApi, B: OpenApi> OpenApi for CombinedAPI<A, B>