Struct SplitResult 

pub struct SplitResult<T: Serialize> {
    pub main: OpenApi,
    pub fragments: Vec<Fragment<T>>,
}

The result of splitting an OpenAPI specification.

Contains the main specification (with $ref references to external files) and a collection of fragments to be written to separate files.

Type Parameters

• T - The type of content in the fragments. Must implement Serialize.

Example

use clawspec_core::split::{OpenApiSplitter, SplitSchemasByTag, SplitResult};

let splitter = SplitSchemasByTag::new("common.yaml");
let result: SplitResult<_> = splitter.split(spec);

// Write fragments to files
for fragment in &result.fragments {
    let yaml = serde_yaml::to_string(&fragment.content)?;
    std::fs::write(&fragment.path, yaml)?;
}

// Write main spec
let main_yaml = serde_yaml::to_string(&result.main)?;
std::fs::write("openapi.yaml", main_yaml)?;

Fields

main: OpenApi

The main OpenAPI specification with $ref references to extracted fragments.

fragments: Vec<Fragment<T>>

Extracted fragments to be written to separate files.

Implementations

impl<T: Serialize> SplitResult<T>

pub fn new(main: OpenApi) -> Self

Creates a new split result with no fragments.

pub fn add_fragment(&mut self, fragment: Fragment<T>)

Adds a fragment to the result.

pub fn is_unsplit(&self) -> bool

Returns true if there are no fragments (no splitting occurred).

pub fn fragment_count(&self) -> usize

Returns the number of fragments.

pub fn main_to_yaml(&self) -> Result<String, YamlError>

Available on crate feature yaml only.

Serializes the main OpenAPI specification to a YAML string.

Requires the yaml feature.

Example

use clawspec_core::split::{OpenApiSplitter, SplitSchemasByTag};

let result = splitter.split(spec);
let main_yaml = result.main_to_yaml()?;
std::fs::write("openapi.yaml", main_yaml)?;

Errors

Returns a YamlError if serialization fails.

Trait Implementations

impl<T: Clone + Serialize> Clone for SplitResult<T>

fn clone(&self) -> SplitResult<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Serialize> Debug for SplitResult<T>

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

Formats the value using the given formatter.