Skip to main content

openapi_forge/
lib.rs

1//! `OpenAPI` 3.0 parser, CRUD grouper, and schema diffing library.
2//!
3//! `openapi-forge` provides a high-level [`Spec`] type that wraps a parsed
4//! `OpenAPI` document and offers helpers for:
5//!
6//! - Endpoint enumeration and lookup
7//! - Schema field resolution (including `allOf` composition)
8//! - Schema diffing (added / removed / changed fields)
9//! - Heuristic and configurable CRUD grouping of RPC-style endpoints
10
11mod error;
12mod spec;
13mod types;
14
15pub use error::ForgeError;
16pub use spec::{
17    CrudGroup, Endpoint, Field, FieldChange, RpcCrudGrouper, RpcCrudVerb, RpcPattern, SchemaDiff,
18    Spec,
19};
20pub use types::{
21    Components, OpenApiSpec, Operation, PathItem, SchemaObject, SchemaOrRef, TypeInfo,
22};