Struct Paths 

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

OpenAPI types re-exported from utoipa for convenience. 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.

extensions: Option<Extensions>

Optional extensions “x-something”.

Implementations

impl Paths

pub fn builder() -> PathsBuilder

Construct a new PathsBuilder.

This is effectively same as calling PathsBuilder::new

impl Paths

pub fn new() -> Paths

Construct a new Paths object.

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

where P: AsRef<str>,

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>( &self, path: P, http_method: HttpMethod, ) -> Option<&Operation>

where P: AsRef<str>,

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 HttpMethod.

Examples

Get user operation from paths.

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

pub fn add_path_operation<P, O>( &mut self, path: P, http_methods: Vec<HttpMethod>, operation: O, )

where P: AsRef<str>, O: Into<Operation>,

Append path operation to the list of paths.

Method accepts three arguments; path to add operation for, http_methods list of allowed HTTP methods for the Operation and operation to be added under the path.

If path already exists, the provided Operation will be set to existing path item for given list of HttpMethods.

pub fn merge(&mut self, other_paths: Paths)

Merge other_paths into self. On conflicting path the path item operations will be merged into existing PathItem. Otherwise path with PathItem will be appended to self. All Extensions will be merged from other_paths into self.

Trait Implementations

impl Clone for Paths

fn clone(&self) -> Paths

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Paths

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

Formats the value using the given formatter.

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<Paths, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PathsBuilder> for Paths

fn from(value: PathsBuilder) -> Paths

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Paths