Struct Api

pub struct Api<P, R, S> {

    pub swagger: Version,
    pub definitions: BTreeMap<String, S>,
    pub paths: BTreeMap<String, PathItem<P, R>>,
    pub host: Option<String>,
    pub base_path: Option<String>,
    pub consumes: BTreeSet<MediaRange>,
    pub produces: BTreeSet<MediaRange>,
    pub schemes: BTreeSet<OperationProtocol>,
    pub parameters: BTreeMap<String, P>,
    pub responses: BTreeMap<String, R>,
    pub security_definitions: BTreeMap<String, SecurityScheme>,
    pub security: Vec<BTreeMap<String, BTreeSet<String>>>,
    pub tags: Vec<Tag>,
    pub external_docs: Option<ExternalDocs>,
    pub coders: Coders,
    pub support_crates: BTreeMap<String, String>,
    pub spec_format: SpecFormat,
    pub info: Info,
    pub extensions: BTreeMap<String, Value>,
}

OpenAPI v2 (swagger) spec generic over parameter and schema.

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swagger-object

Fields

swagger: Version

definitions: BTreeMap<String, S>

paths: BTreeMap<String, PathItem<P, R>>

host: Option<String>

base_path: Option<String>

consumes: BTreeSet<MediaRange>

produces: BTreeSet<MediaRange>

schemes: BTreeSet<OperationProtocol>

parameters: BTreeMap<String, P>

responses: BTreeMap<String, R>

security_definitions: BTreeMap<String, SecurityScheme>

security: Vec<BTreeMap<String, BTreeSet<String>>>

tags: Vec<Tag>

external_docs: Option<ExternalDocs>

coders: Coders

Extension for custom coders to be used for decoding API objects.

An example for JSON would be:

x-rust-coders:
  application/json:
    encoder_path: serde_json::to_writer
    decoder_path: serde_json::from_reader
    any_value: serde_json::Value
    error_path: serde_json::Error

NOTE: JSON and YAML encodings are already supported.

support_crates: BTreeMap<String, String>

Additional crates that need to be added to the manifest.

The key is the LHS of a dependency, which is the crate name. The value is the RHS of a crate’s requirements as it would appear in the manifest. Note that the caller must add proper escaping wherever required.

For example, the following are all valid:

• my_crate: "0.7"
• my_crate: "{ git = \"git://foo.bar/repo\" }"
• my_crate: "{ version = \"0.9\", features = [\"booya\"] }"

spec_format: SpecFormat

This field is set manually, because we don’t know the format in which the spec was provided and we need to use this as the fallback encoding.

info: Info

extensions: BTreeMap<String, Value>

Implementations

impl<P, R, S> Api<P, R, S>

pub fn path_parameters_map( path: &str, f: impl FnMut(&str) -> Cow<'static, str>, ) -> Cow<'_, str>

Gets the parameters from the given path template and calls the given function with the parameter names.

impl<S: Schema + Default> Api<Arc<RwLock<Parameter<Resolvable<S>>>>, Arc<RwLock<Response<Resolvable<S>>>>, Resolvable<S>>

pub fn resolve(self) -> Result<ResolvableApi<S>, ValidationError>

Consumes this API schema, resolves the references and returns the resolved schema.

This walks recursively, collects the referenced schema objects, substitutes the referenced IDs with the pointer to schema objects and returns the resolved object or an error if it encountered one.

Trait Implementations

impl<P: Clone, R: Clone, S: Clone> Clone for Api<P, R, S>

fn clone(&self) -> Api<P, R, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug, R: Debug, S: Debug> Debug for Api<P, R, S>

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

Formats the value using the given formatter.

impl<P: Default, R: Default, S: Default> Default for Api<P, R, S>

fn default() -> Api<P, R, S>

Returns the “default value” for a type.

impl<'de, P, R, S> Deserialize<'de> for Api<P, R, S>

where P: Deserialize<'de>, R: Deserialize<'de>, S: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Api<Parameter<DefaultSchemaRaw>, Response<DefaultSchemaRaw>, DefaultSchemaRaw>> for OpenAPI

fn from(v2: DefaultApiRaw) -> Self

Converts to this type from the input type.

impl<P, R, S> Serialize for Api<P, R, S>

where P: Serialize, R: Serialize, S: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.