Struct Schema 

pub struct Schema {

    pub title: Option<String>,
    pub description: Option<String>,
    pub schema_type: SchemaType,
    pub properties: Option<BTreeMap<String, Schema>>,
    pub required: Option<Vec<String>>,
    pub items: Option<Box<Schema>>,
    pub enum_values: Option<Vec<Value>>,
    pub default: Option<Value>,
    pub example: Option<Value>,
    pub nullable: bool,
    pub read_only: bool,
    pub write_only: bool,
    pub minimum: Option<f64>,
    pub maximum: Option<f64>,
    pub min_length: Option<usize>,
    pub max_length: Option<usize>,
    pub pattern: Option<String>,
    pub format: Option<String>,
    pub one_of: Option<Vec<Schema>>,
    pub any_of: Option<Vec<Schema>>,
    pub all_of: Option<Vec<Schema>>,
}

Schema 定义

Fields

title: Option<String>

Schema 标题

description: Option<String>

Schema 描述

schema_type: SchemaType

Schema 类型

properties: Option<BTreeMap<String, Schema>>

属性定义（仅 Object 类型）

required: Option<Vec<String>>

必需属性列表

items: Option<Box<Schema>>

数组元素类型（仅 Array 类型）

enum_values: Option<Vec<Value>>

枚举值

default: Option<Value>

默认值

example: Option<Value>

示例值

nullable: bool

是否可为空

read_only: bool

只读

write_only: bool

只写

minimum: Option<f64>

最小值（Number/Integer）

maximum: Option<f64>

最大值（Number/Integer）

min_length: Option<usize>

最小长度（String）

max_length: Option<usize>

最大长度（String）

pattern: Option<String>

正则模式（String）

format: Option<String>

格式（String）

one_of: Option<Vec<Schema>>

多个类型（用于 oneOf）

any_of: Option<Vec<Schema>>

多个类型（用于 anyOf）

all_of: Option<Vec<Schema>>

多个类型（用于 allOf）

Implementations

impl Schema

pub fn string() -> Self

创建字符串 Schema

pub fn integer() -> Self

创建整数 Schema

pub fn number() -> Self

创建数字 Schema

pub fn boolean() -> Self

创建布尔 Schema

pub fn array(items: Schema) -> Self

创建数组 Schema

pub fn object() -> Self

创建对象 Schema

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

设置标题

pub fn description(self, desc: impl Into<String>) -> Self

设置描述

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

添加属性

pub fn required(self, fields: Vec<&str>) -> Self

设置必需属性

pub fn enum_values(self, values: Vec<Value>) -> Self

设置枚举值

pub fn with_default(self, value: Value) -> Self

设置默认值

pub fn example(self, value: Value) -> Self

设置示例值

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

设置格式

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

设置正则模式

pub fn min_length(self, len: usize) -> Self

设置最小长度

pub fn max_length(self, len: usize) -> Self

设置最大长度

pub fn minimum(self, min: f64) -> Self

设置最小值

pub fn maximum(self, max: f64) -> Self

设置最大值

pub fn nullable(self, nullable: bool) -> Self

设置可为空

pub fn read_only(self, read_only: bool) -> Self

设置只读

pub fn write_only(self, write_only: bool) -> Self

设置只写

pub fn one_of(self, schemas: Vec<Schema>) -> Self

设置 oneOf

pub fn any_of(self, schemas: Vec<Schema>) -> Self

设置 anyOf

pub fn all_of(self, schemas: Vec<Schema>) -> Self

设置 allOf

pub fn to_json_schema(&self) -> Value

转换为 JSON Schema

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Default for Schema

fn default() -> Self

创建默认的 Schema（Object 类型）

impl<'de> Deserialize<'de> for Schema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Schema

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

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 Schema