Struct rweb::openapi::Spec

pub struct Spec {
    pub openapi: Cow<'static, str>,
    pub info: Info,
    pub servers: Vec<Server>,
    pub paths: BTreeMap<Cow<'static, str>, PathItem>,
    pub components: Option<Components>,
    pub tags: Vec<Tag>,
    pub external_docs: Option<ExternalDoc>,
}

top level document

Fields

openapi: Cow<'static, str>

This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.

info: Info

Provides metadata about the API. The metadata MAY be used by tooling as required.

servers: Vec<Server>

An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.

paths: BTreeMap<Cow<'static, str>, PathItem>

Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths MAY be empty, due to ACL constraints.

components: Option<Components>

An element to hold various schemas for the specification.

tags: Vec<Tag>

A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.

external_docs: Option<ExternalDoc>

Additional external documentation.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl Default for Spec

fn default() -> Spec

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Spec

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Spec, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Spec> for Spec

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Spec

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Spec