Struct Swagger

pub struct Swagger {

    pub swagger: String,
    pub info: Option<Info>,
    pub host: String,
    pub base_path: String,
    pub schemes: Vec<i32>,
    pub consumes: Vec<String>,
    pub produces: Vec<String>,
    pub responses: HashMap<String, Response>,
    pub security_definitions: Option<SecurityDefinitions>,
    pub security: Vec<SecurityRequirement>,
    pub tags: Vec<Tag>,
    pub external_docs: Option<ExternalDocumentation>,
    pub extensions: HashMap<String, Value>,
}

Swagger is a representation of OpenAPI v2 specification’s Swagger object.

See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject

Example:

option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { info: { title: “Echo API”; version: “1.0”; description: “”; contact: { name: “gRPC-Gateway project”; url: “https://github.com/grpc-ecosystem/grpc-gateway"; email: “none@example.com”; }; license: { name: “BSD 3-Clause License”; url: “https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE"; }; }; schemes: HTTPS; consumes: “application/json”; produces: “application/json”; };

Fields

swagger: String

Specifies the OpenAPI Specification version being used. It can be used by the OpenAPI UI and other clients to interpret the API listing. The value MUST be “2.0”.

info: Option<Info>

Provides metadata about the API. The metadata can be used by the clients if needed.

host: String

The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.

base_path: String

The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating. Note that using base_path does not change the endpoint paths that are generated in the resulting OpenAPI file. If you wish to use base_path with relatively generated OpenAPI paths, the base_path prefix must be manually removed from your google.api.http paths and your code changed to serve the API from the base_path.

schemes: Vec<i32>

The transfer protocol of the API. Values MUST be from the list: “http”, “https”, “ws”, “wss”. If the schemes is not included, the default scheme to be used is the one used to access the OpenAPI definition itself.

consumes: Vec<String>

A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.

produces: Vec<String>

A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.

responses: HashMap<String, Response>

An object to hold responses that can be used across operations. This property does not define global responses for all operations.

security_definitions: Option<SecurityDefinitions>

Security scheme definitions that can be used across the specification.

security: Vec<SecurityRequirement>

A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition.

tags: Vec<Tag>

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

external_docs: Option<ExternalDocumentation>

Additional external documentation.

extensions: HashMap<String, Value>

Custom properties that start with “x-” such as “x-foo” used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

Implementations

impl Swagger

pub fn schemes( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<Scheme>>

Returns an iterator which yields the valid enum values contained in schemes.

pub fn push_schemes(&mut self, value: Scheme)

Appends the provided enum value to schemes.

Trait Implementations

impl Clone for Swagger

fn clone(&self) -> Swagger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Swagger

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

Formats the value using the given formatter.

impl Default for Swagger

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Swagger

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Swagger

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Swagger

fn eq(&self, other: &Swagger) -> 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 Swagger

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Swagger