Struct PathsBuilder

pub struct PathsBuilder { /* private fields */ }

Builder for Paths with chainable configuration methods to create a new Paths.

Implementations

impl PathsBuilder

pub fn new() -> PathsBuilder

Constructs a new PathsBuilder.

pub fn build(self) -> Paths

Constructs a new Paths taking all fields values from this object.

impl PathsBuilder

pub fn path<I>(self, path: I, item: PathItem) -> PathsBuilder

where I: Into<String>,

Append PathItem with path to map of paths. If path already exists it will merge Operations of PathItem with already found path item operations.

pub fn extensions(self, extensions: Option<Extensions>) -> PathsBuilder

Add extensions to the paths section.

pub fn path_from<P>(self) -> PathsBuilder

where P: Path,

Appends a Path to map of paths. Method must be called with one generic argument that implements Path trait.

Examples

Append MyPath content to the paths.

let paths = utoipa::openapi::path::PathsBuilder::new();
let _ = paths.path_from::<MyPath>();

Trait Implementations

impl Default for PathsBuilder

fn default() -> PathsBuilder

Returns the “default value” for a type.

impl From<Paths> for PathsBuilder

fn from(value: Paths) -> PathsBuilder

Converts to this type from the input type.

impl From<PathsBuilder> for Paths

fn from(value: PathsBuilder) -> Paths

Converts to this type from the input type.