Struct ProxyConfig 

pub struct ProxyConfig {
    pub path: Option<String>,
    pub domain: Option<String>,
    pub port: Option<u16>,
    pub target: String,
    pub middlewares: Option<Vec<String>>,
}

proxy configuration.

Note: path should not be set at the same time as either domain or port. path takes precedence and the other sources will be ignored.

if the path, domain and port are all unset, validation will fail.

Fields

path: Option<String>

an axum route with a *path wildcard that will be appended to the target.

i.e. "/some/path/{*path}"

Note: MUST end in a trailing /{*path}

domain: Option<String>

custom domain with an ALIAS/CNAME pointing at the primary OrdinaryConfig::domain and a TXT record indicating ownership (i.e. ordinary-proxy=your.config.domain).

i.e example.com

Note: if a path is specified, the domain will be ignored

port: Option<u16>

preferred port that the proxy will listen on in a --dedicated-ports configured multi-tenant server OR a standalone app instance.

i.e 8081

Note: if a path is specified, the port will be ignored, and port will not be tried without domain being present.

target: String

url for resource to proxy.

i.e. https://example.com

middlewares: Option<Vec<String>>

list of names of middleware to include for this proxy

Trait Implementations

impl Clone for ProxyConfig

fn clone(&self) -> ProxyConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComposeSchema for ProxyConfig

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for ProxyConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProxyConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ProxyConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ProxyConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for ProxyConfig

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.