Struct OpenApiSchema 

pub struct OpenApiSchema { /* private fields */ }

Represents OpenAPI schema.

Implementations

impl OpenApiSchema

pub fn with_constraint(self, constraint: SchemaConstraint) -> Self

Applies a constraint to this schema

pub fn object() -> Self

Generates schema for object field

pub fn string() -> Self

Generates schema for string field

pub fn integer() -> Self

Generates schema for integer field

pub fn number() -> Self

Generates schema for number field

pub fn boolean() -> Self

Generates schema for boolean field

pub fn binary() -> Self

Generates schema for binary field

pub fn multipart() -> Self

Generates schema for multipart form data

pub fn array(items: OpenApiSchema) -> Self

Generates schema for an array of items

pub fn reference(name: &str) -> Self

Generates schema reference

pub fn from_example(example: &Value) -> Self

Generates schema from example

pub fn nullable(self) -> Self

Makes schema nullable

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the title

pub fn with_property( self, name: impl Into<String>, schema: OpenApiSchema, ) -> Self

Sets the property schema

pub fn with_format(self, fmt: impl Into<String>) -> Self

Sets the format

pub fn with_required<I, T>(self, required: I) -> Self

where I: IntoIterator<Item = T>, T: Into<String>,

Sets the required fields for schema

pub fn is_ref(&self) -> bool

Returns true if this schema is a reference

Trait Implementations

impl Clone for OpenApiSchema

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiSchema

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

Formats the value using the given formatter.

impl Default for OpenApiSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenApiSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenApiSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.