Skip to main content

Crate openapi_forge

Crate openapi_forge 

Source
Expand description

OpenAPI 3.0 parser, CRUD grouper, and schema diffing library.

openapi-forge provides a high-level Spec type that wraps a parsed OpenAPI document and offers helpers for:

  • Endpoint enumeration and lookup
  • Schema field resolution (including allOf composition)
  • Schema diffing (added / removed / changed fields)
  • Heuristic and configurable CRUD grouping of RPC-style endpoints

Structs§

Components
Holds reusable schema, parameter, request body, and response definitions.
CrudGroup
A group of related CRUD endpoints sharing a common resource name.
Endpoint
A resolved endpoint with its request/response schema names.
Field
A resolved field from a component schema.
FieldChange
A field whose type or required status changed between two schema versions.
OpenApiSpec
Root OpenAPI 3.0 specification object.
Operation
A single API operation on a path (e.g. GET, POST).
PathItem
Describes the operations available on a single path.
RpcCrudGrouper
Configurable grouper for RPC-style CRUD APIs.
RpcPattern
A pattern that matches RPC-style operation paths to CRUD verbs and resource names.
SchemaDiff
Result of diffing two schemas by field name.
Spec
High-level representation of a parsed and queryable OpenAPI spec.

Enums§

ForgeError
Errors that can occur when loading, parsing, or querying an OpenAPI spec.
RpcCrudVerb
The CRUD verb detected from an RPC-style operation path.
SchemaOrRef
Adapter: convert sekkei’s flat Schema (with optional ref_path) to the SchemaOrRef enum pattern used by openapi-forge consumers.
TypeInfo
Platform-independent field type for code generation.

Type Aliases§

SchemaObject
Alias: SchemaObject is now sekkei::Schema.