Struct OpenApi31Spec 

pub struct OpenApi31Spec {
    pub openapi: String,
    pub info: ApiInfo31,
    pub json_schema_dialect: Option<String>,
    pub servers: Option<Vec<Server>>,
    pub paths: HashMap<String, PathItem>,
    pub webhooks: Option<HashMap<String, Webhook>>,
    pub components: Option<Components31>,
    pub security: Option<Vec<HashMap<String, Vec<String>>>>,
    pub tags: Option<Vec<Tag>>,
    pub external_docs: Option<ExternalDocs>,
}

OpenAPI 3.1.0 specification

Fields

openapi: String

OpenAPI version (always “3.1.0”)

info: ApiInfo31

API information

json_schema_dialect: Option<String>

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

servers: Option<Vec<Server>>

Server list

paths: HashMap<String, PathItem>

API paths

webhooks: Option<HashMap<String, Webhook>>

Webhooks (new in 3.1)

components: Option<Components31>

Components (schemas, security schemes, etc.)

security: Option<Vec<HashMap<String, Vec<String>>>>

Security requirements

tags: Option<Vec<Tag>>

Tags for organization

external_docs: Option<ExternalDocs>

External documentation

Implementations

impl OpenApi31Spec

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

Create a new OpenAPI 3.1.0 specification

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

Set API description

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

Set API summary (new in 3.1)

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

Set terms of service URL

pub fn contact(self, contact: Contact) -> Self

Set contact information

pub fn license(self, license: License) -> Self

Set license information

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

Add a server

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

Add a path operation

pub fn webhook(self, name: impl Into<String>, webhook: Webhook) -> Self

Add a webhook (new in 3.1)

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

Add a schema to components

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

Add a schema from an existing OpenAPI 3.0 schema (will be transformed)

pub fn register<T: for<'a> ToSchema<'a>>(self) -> Self

Register a type that implements utoipa::ToSchema

The schema will be automatically transformed to OpenAPI 3.1 format

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

Add a security scheme

pub fn security_requirement( self, name: impl Into<String>, scopes: Vec<String>, ) -> Self

Add a global security requirement

pub fn tag(self, tag: Tag) -> Self

Add a tag

pub fn external_docs(self, docs: ExternalDocs) -> Self

Set external documentation

pub fn callback(self, name: impl Into<String>, callback: Callback) -> Self

Add a callback to components

pub fn to_json(&self) -> Value

Convert to JSON value

pub fn to_json_pretty(&self) -> String

Convert to pretty-printed JSON string

Trait Implementations

impl Clone for OpenApi31Spec

fn clone(&self) -> OpenApi31Spec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApi31Spec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenApi31Spec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenApi31Spec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.