Struct ApiSchema 

pub struct ApiSchema {
    pub name: String,
    pub description: Option<String>,
    pub version: ApiVersion,
    pub base_path: String,
    pub endpoints: Vec<ApiEndpoint>,
    pub definitions: HashMap<String, SchemaType>,
    pub tags: Vec<String>,
    pub contact: Option<String>,
    pub license: Option<String>,
}

Complete API schema for a node

Fields

name: String

Schema name

description: Option<String>

Schema description

version: ApiVersion

API version

base_path: String

Base path prefix

endpoints: Vec<ApiEndpoint>

Available endpoints

definitions: HashMap<String, SchemaType>

Shared schema definitions (for $ref)

tags: Vec<String>

Global tags

contact: Option<String>

Contact information

license: Option<String>

License

Implementations

impl ApiSchema

pub fn new(name: impl Into<String>, version: ApiVersion) -> Self

Create a new API schema

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

Set description

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

Set base path

pub fn add_endpoint(self, endpoint: ApiEndpoint) -> Self

Add endpoint

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

Add schema definition

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

Add tag

pub fn find_endpoint( &self, path: &str, method: ApiMethod, ) -> Option<&ApiEndpoint>

Find endpoint by path and method

pub fn endpoints_by_tag(&self, tag: &str) -> Vec<&ApiEndpoint>

Get all endpoints with a specific tag

pub fn to_bytes(&self) -> Vec<u8>

Serialize to bytes

pub fn from_bytes(bytes: &[u8]) -> Option<Self>

Deserialize from bytes

Trait Implementations

impl Clone for ApiSchema

fn clone(&self) -> ApiSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ApiSchema

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

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 ApiSchema