Struct apidoc_core::document::ApiDocument

pub struct ApiDocument {
    pub ident: String,
    pub name: String,
    pub note: Option<String>,
    pub version: Option<String>,
    pub modules: HashMap<String, ApiModule>,
    pub resources: Vec<ApiResource>,
    pub operations: Vec<ApiOperation>,
    pub models: HashMap<String, ApiModel>,
    pub errors: Vec<ApiErrorItem>,
}

Fields

ident: String

name: String

note: Option<String>

version: Option<String>

modules: HashMap<String, ApiModule>

resources: Vec<ApiResource>

operations: Vec<ApiOperation>

models: HashMap<String, ApiModel>

errors: Vec<ApiErrorItem>

Trait Implementations

impl Debug for ApiDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.