Struct utoipa::openapi::server::Server

#[non_exhaustive]
pub struct Server {
    pub url: String,
    pub description: Option<String>,
    pub variables: Option<BTreeMap<String, ServerVariable>>,
}

Represents target server object. It can be used to alter server connection for path operations.

By default OpenAPI will implicitly implement Server with url = "/" if no servers is provided to the OpenApi.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

url: String

Target url of the Server. It can be valid http url or relative path.

Url also supports variable substitution with {variable} syntax. The substitutions then can be configured with Server::variables map.

description: Option<String>

Optional description describing the target server url. Description supports markdown syntax.

variables: Option<BTreeMap<String, ServerVariable>>

Optional map of variable name and its substitution value used in Server::url.

Implementations

impl Server

pub fn new<S: Into<String>>(url: S) -> Self

Construct a new Server with given url. Url can be valid http url or context path of the url.

If url is valid http url then all path operation request’s will be forwarded to the selected Server.

If url is path of url e.g. /api/v1 then the url will be appended to the servers address and the operations will be forwarded to location server address + url.

Examples

Create new server with url path.

 Server::new("/api/v1");

Create new server with alternative server.

 Server::new("https://alternative.pet-api.test/api/v1");

Trait Implementations

impl Clone for Server

fn clone(&self) -> Server

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Server

fn default() -> Server

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Server

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Server> for ServerBuilder

fn from(value: Server) -> Self

Converts to this type from the input type.

impl From<ServerBuilder> for Server

fn from(value: ServerBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for Server

fn eq(&self, other: &Server) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Server

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Server

impl StructuralPartialEq for Server