Skip to main content

OpenApiBuilder

Struct OpenApiBuilder 

Source
pub struct OpenApiBuilder { /* private fields */ }
Expand description

Builder for composing OpenAPI specs from multiple sources.

§Example

use server_less::OpenApiBuilder;

let spec = OpenApiBuilder::new()
    .title("My API")
    .version("1.0.0")
    .merge(UserService::openapi_spec())
    .merge(OrderService::openapi_spec())
    .build()?;

§Conflict Resolution

  • Paths: Last write wins (later merge() calls override earlier ones for same path+method).
  • Schemas: Identical schemas are deduplicated; different schemas with same name cause an error.

Implementations§

Source§

impl OpenApiBuilder

Source

pub fn new() -> OpenApiBuilder

Create a new builder.

Source

pub fn title(self, title: impl Into<String>) -> OpenApiBuilder

Set the API title.

Source

pub fn version(self, version: impl Into<String>) -> OpenApiBuilder

Set the API version.

Source

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

Set the API description.

Source

pub fn merge(self, spec: Value) -> Result<OpenApiBuilder, OpenApiError>

Merge an OpenAPI spec (as JSON value).

This extracts paths and schemas from the spec and merges them.

§Conflict Resolution
  • Paths: Last write wins
  • Schemas: Identical schemas dedupe, different schemas error
Source

pub fn merge_paths(self, paths: Vec<OpenApiPath>) -> OpenApiBuilder

Merge typed paths.

Source

pub fn merge_schemas( self, schemas: Vec<OpenApiSchema>, ) -> Result<OpenApiBuilder, OpenApiError>

Merge typed schemas.

Source

pub fn build(self) -> Value

Build the final OpenAPI spec.

Trait Implementations§

Source§

impl Clone for OpenApiBuilder

Source§

fn clone(&self) -> OpenApiBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpenApiBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OpenApiBuilder

Source§

fn default() -> OpenApiBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,