Trait poem_openapi::OpenApi

pub trait OpenApi: Sized {
    fn meta() -> Vec<MetaApi>;
    fn register(registry: &mut Registry);
    fn add_routes(self, route: Route) -> Route;

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

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: 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.

Implementors

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