Interface IDocument

Root document for Restful API operations and components.

Corresponds to the top-level OpenAPI structure, containing all API operations and reusable component schemas.

interface IDocument {
components: IComponents;
operations: IOperation[];
}

Index

Properties

components operations

Properties

components

components: IComponents

Reusable components referenced by API operations.

Type naming conventions for schemas:

IEntityName: Full detailed entity (e.g., IShoppingSale)
IEntityName.ICreate: Request body for POST creation
IEntityName.IUpdate: Request body for PUT update
IEntityName.IRequest: Search/filter/pagination parameters
IEntityName.ISummary: Simplified view for list operations
IEntityName.IAbridge: Intermediate detail level
IEntityName.IInvert: Alternative perspective of an entity
IPageIEntityName: Paginated results with pagination and data

operations

operations: IOperation[]

List of API operations.

Combination of AutoBeOpenApi.IOperation.path and AutoBeOpenApi.IOperation.method must be unique.

Min Items

1