Struct OpenApiSpec 

pub struct OpenApiSpec {
    pub info: ApiInfo,
    pub paths: HashMap<String, PathItem>,
    pub schemas: HashMap<String, Value>,
}

OpenAPI specification builder

Fields

info: ApiInfo

paths: HashMap<String, PathItem>

schemas: HashMap<String, Value>

Implementations

impl OpenApiSpec

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

Create a new OpenAPI specification

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

Set description

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

Add a path operation

pub fn schema(self, name: &str, schema: Value) -> Self

Add a schema definition

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

Register a type that implements Schema (utoipa::ToSchema)

pub fn to_json(&self) -> Value

Convert to JSON 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.