Struct poem_openapi::OpenApiService

pub struct OpenApiService<T, W> { /* private fields */ }

An OpenAPI service for Poem.

Implementations

impl<T> OpenApiService<T, ()>

pub fn new(api: T, title: impl Into<String>, version: impl Into<String>) -> Self

Create an OpenAPI container.

impl<T, W> OpenApiService<T, W>

pub fn webhooks<W2>(self) -> OpenApiService<T, W2>

Sets the webhooks.

pub fn summary(self, summary: impl Into<String>) -> Self

Sets the summary of the API container.

pub fn description(self, description: impl Into<String>) -> Self

Sets the description of the API container.

pub fn terms_of_service(self, url: impl Into<String>) -> Self

Sets a URL to the Terms of Service for the API.

pub fn server(self, server: impl Into<ServerObject>) -> Self

Appends a server to the API container.

Reference: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#serverObject

pub fn contact(self, contact: ContactObject) -> Self

Sets the contact information for the exposed API.

pub fn license(self, license: impl Into<LicenseObject>) -> Self

Sets the license information for the exposed API.

Reference: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object

pub fn external_document(
    self,
    external_document: impl Into<ExternalDocumentObject>
) -> Self

Add a external document object.

Reference: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#external-documentation-object

pub fn extra_response_header<HT, H>(self, header: H) -> Selfwhere
    HT: Type,
    H: Into<ExtraHeader>,

Add extra response header

pub fn extra_request_header<HT, H>(self, header: H) -> Selfwhere
    HT: Type,
    H: Into<ExtraHeader>,

Add extra request header

pub fn cookie_key(self, key: CookieKey) -> Self

Sets the cookie key.

pub fn url_prefix(self, url_prefix: impl Into<String>) -> Self

Sets optional URl prefix to be added to path

pub fn openapi_explorer(&self) -> impl Endpointwhere
    T: OpenApi,
    W: Webhook,

Create the OpenAPI Explorer endpoint.

pub fn openapi_explorer_html(&self) -> Stringwhere
    T: OpenApi,
    W: Webhook,

Create the OpenAPI Explorer HTML

pub fn swagger_ui(&self) -> impl Endpointwhere
    T: OpenApi,
    W: Webhook,

Create the Swagger UI endpoint.

pub fn swagger_ui_html(&self) -> Stringwhere
    T: OpenApi,
    W: Webhook,

Create the Swagger UI HTML

pub fn rapidoc(&self) -> impl Endpointwhere
    T: OpenApi,
    W: Webhook,

Create the Rapidoc endpoint.

pub fn rapidoc_html(&self) -> Stringwhere
    T: OpenApi,
    W: Webhook,

Create the Rapidoc HTML

pub fn redoc(&self) -> impl Endpointwhere
    T: OpenApi,
    W: Webhook,

Create the Redoc endpoint.

pub fn redoc_html(&self) -> Stringwhere
    T: OpenApi,
    W: Webhook,

Create the Redoc HTML

pub fn spec_endpoint(&self) -> impl Endpointwhere
    T: OpenApi,
    W: Webhook,

Create an endpoint to serve the open api specification as JSON.

pub fn spec_endpoint_yaml(&self) -> impl Endpointwhere
    T: OpenApi,
    W: Webhook,

Create an endpoint to serve the open api specification as YAML.

pub fn spec(&self) -> Stringwhere
    T: OpenApi,
    W: Webhook,

Returns the OAS specification file as JSON.

pub fn spec_yaml(&self) -> Stringwhere
    T: OpenApi,
    W: Webhook,

Returns the OAS specification file as YAML.

Trait Implementations

impl<T: OpenApi, W: Webhook> IntoEndpoint for OpenApiService<T, W>

type Endpoint = Box<dyn Endpoint<Output = Response> + 'static, Global>

Represents the endpoint type.

fn into_endpoint(self) -> Self::Endpoint

Converts this object into endpoint.