Struct utoipa::openapi::path::Paths

#[non_exhaustive]
pub struct Paths {
    pub paths: BTreeMap<String, PathItem>,
}

Implements OpenAPI Paths Object.

Holds relative paths to matching endpoints and operations. The path is appended to the url from Server object to construct a full url for endpoint.

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.

paths: BTreeMap<String, PathItem>

Map of relative paths with PathItems holding Operations matching api endpoints.

Implementations

impl Paths

pub fn new() -> Self

Construct a new Paths object.

pub fn get_path_item<P: AsRef<str>>(&self, path: P) -> Option<&PathItem>

Return Option of reference to PathItem by given relative path P if one exists in Paths::paths map. Otherwise will return None.

Examples

Get user path item.

let path_item = paths.get_path_item("/api/v1/user");

pub fn get_path_operation<P: AsRef<str>>( &self, path: P, item_type: PathItemType, ) -> Option<&Operation>

Return Option of reference to Operation from map of paths or None if not found.

• First will try to find PathItem by given relative path P e.g. "/api/v1/user".
• Then tries to find Operation from PathItem’s operations by given PathItemType.

Examples

Get user operation from paths.

let operation = paths.get_path_operation("/api/v1/user", PathItemType::Get);

Trait Implementations

impl Clone for Paths

fn clone(&self) -> Paths

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Paths

fn default() -> Paths

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Paths

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Paths> for PathsBuilder

fn from(value: Paths) -> Self

Converts to this type from the input type.

impl From<PathsBuilder> for Paths

fn from(value: PathsBuilder) -> Self

Converts to this type from the input type.

impl PartialEq for Paths

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

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 Paths