Struct OpenApiSpec 

pub struct OpenApiSpec {
    pub openapi: String,
    pub info: ApiInfo,
    pub json_schema_dialect: Option<String>,
    pub servers: Vec<Server>,
    pub paths: BTreeMap<String, PathItem>,
    pub webhooks: BTreeMap<String, PathItem>,
    pub components: Option<Components>,
    pub security: Vec<BTreeMap<String, Vec<String>>>,
    pub tags: Vec<Tag>,
    pub external_docs: Option<ExternalDocs>,
}

OpenAPI 3.1.0 specification

Fields

openapi: String

OpenAPI version (always “3.1.0”)

info: ApiInfo

API information

json_schema_dialect: Option<String>

JSON Schema dialect (optional, defaults to JSON Schema 2020-12)

servers: Vec<Server>

Server list

paths: BTreeMap<String, PathItem>

API paths

webhooks: BTreeMap<String, PathItem>

Webhooks

components: Option<Components>

Components

security: Vec<BTreeMap<String, Vec<String>>>

Security requirements

tags: Vec<Tag>

Tags

external_docs: Option<ExternalDocs>

External documentation

Implementations

impl OpenApiSpec

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

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

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

pub fn path(self, path: &str, method: &str, operation: Operation) -> Self

pub fn register<T: RustApiSchema>(self) -> Self

Register a type that implements RustApiSchema

pub fn register_in_place<T: RustApiSchema>(&mut self)

Register a type into this spec in-place.

pub fn server(self, server: Server) -> Self

pub fn security_scheme( self, name: impl Into<String>, scheme: SecurityScheme, ) -> Self

pub fn to_json(&self) -> Value

Trait Implementations

impl Clone for OpenApiSpec

fn clone(&self) -> OpenApiSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenApiSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenApiSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.