Struct Server 

pub struct Server {
    pub url: String,
    pub description: Option<String>,
    pub variables: Option<BTreeMap<String, ServerVariable>>,
    pub extensions: Option<BTreeMap<String, Value>>,
}

An object representing a Server.

Specification example:

servers:
- url: https://{username}.gigantic-server.com:{port}/{basePath}
  description: The production API server
  variables:
    username:
      # note! no enum here means it is an open value
      default: demo
      description: this value is assigned by the service provider, in this example `gigantic-server.com`
    port:
      enum:
        - '8443'
        - '443'
      default: '8443'
    basePath:
      # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2`
      default: v2

Fields

url: String

Required A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.

description: Option<String>

An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.

variables: Option<BTreeMap<String, ServerVariable>>

A map between a variable name and its value. The value is used for substitution in the server’s URL template.

extensions: Option<BTreeMap<String, Value>>

This object MAY be extended with Specification Extensions. The field name MUST begin with x-, for example, x-internal-id. The value can be null, a primitive, an array or an object.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Server

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Server

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

Formats the value using the given formatter.

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 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 ValidateWithContext<Spec> for Server

fn validate_with_context(&self, ctx: &mut Context<'_, Spec>, path: String)

impl StructuralPartialEq for Server