Struct dropshot::ApiDescription

pub struct ApiDescription { /* fields omitted */ }

An ApiDescription represents the endpoints and handler functions in your API. Other metadata could also be provided here. This object can be used to generate an OpenAPI spec or to run an HTTP server implementing the API.

Implementations

impl ApiDescription

pub fn new() -> Self

pub fn register<T>(&mut self, endpoint: T) -> Result<(), String> where
    T: Into<ApiEndpoint>, 

Register a new API endpoint.

pub fn print_openapi(
    &self,
    out: &mut dyn Write,
    title: &dyn ToString,
    description: Option<&dyn ToString>,
    terms_of_service: Option<&dyn ToString>,
    contact_name: Option<&dyn ToString>,
    contact_url: Option<&dyn ToString>,
    contact_email: Option<&dyn ToString>,
    license_name: Option<&dyn ToString>,
    license_url: Option<&dyn ToString>,
    version: &dyn ToString
) -> Result<()>

Emit the OpenAPI Spec document describing this API in its JSON form.

pub fn into_router(self) -> HttpRouter