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
allOfcomposition) - 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.
- Crud
Group - 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.
- Field
Change - A field whose type or required status changed between two schema versions.
- Open
ApiSpec - Root
OpenAPI3.0 specification object. - Operation
- A single API operation on a path (e.g. GET, POST).
- Path
Item - Describes the operations available on a single path.
- RpcCrud
Grouper - Configurable grouper for RPC-style CRUD APIs.
- RpcPattern
- A pattern that matches RPC-style operation paths to CRUD verbs and resource names.
- Schema
Diff - Result of diffing two schemas by field name.
- Spec
- High-level representation of a parsed and queryable
OpenAPIspec.
Enums§
- Forge
Error - Errors that can occur when loading, parsing, or querying an
OpenAPIspec. - RpcCrud
Verb - The CRUD verb detected from an RPC-style operation path.
- Schema
OrRef - Adapter: convert sekkei’s flat
Schema(with optionalref_path) to theSchemaOrRefenum pattern used by openapi-forge consumers. - Type
Info - Platform-independent field type for code generation.
Type Aliases§
- Schema
Object - Alias:
SchemaObjectis nowsekkei::Schema.