Struct okapi::openapi3::OpenApi

pub struct OpenApi {
    pub openapi: String,
    pub info: Info,
    pub servers: Vec<Server>,
    pub paths: Map<String, PathItem>,
    pub components: Option<Components>,
    pub security: Vec<SecurityRequirement>,
    pub tags: Vec<Tag>,
    pub external_docs: Option<ExternalDocs>,
    pub extensions: Object,
}

Fields

openapi: String

info: Info

servers: Vec<Server>

paths: Map<String, PathItem>

components: Option<Components>

security: Vec<SecurityRequirement>

tags: Vec<Tag>

external_docs: Option<ExternalDocs>

extensions: Object

Implementations

impl OpenApi

pub fn merge_spec<S: Display>( self, path_prefix: &S, s2: &Self ) -> Result<(), MergeError>

Merge the given OpenAPI spec into the current one.

impl OpenApi

pub fn new() -> Self

pub fn default_version() -> String

Trait Implementations

impl Clone for OpenApi

fn clone(&self) -> OpenApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApi

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

Formats the value using the given formatter.

impl Default for OpenApi

fn default() -> OpenApi

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenApi

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for OpenApi

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for OpenApi

fn eq(&self, other: &OpenApi) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OpenApi

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 OpenApi