Types and helpers for packages contributing Model API builders.
npm install @loopback/model-api-builderTypes and helpers for packages contributing Model API builders.
The @loopback/model-api-builder package provides a contract for extensions
that contribute builders for repositories and controllers. Users provide both
the model class and an extension. The extension is then used to build their
repository and controller based on the model class.
``sh`
npm install --save @loopback/model-api-builder
An extension that contributes the repository and controller builders can be made
by implementing ModelApiBuilder:
`ts
import {
asModelApiBuilder,
ModelApiBuilder,
ModelApiConfig,
} from '@loopback/model-api-builder';
@injectable(asModelApiBuilder)
export class SampleApiBuilder implements ModelApiBuilder {
readonly pattern: string = 'Sample';
build(
application: ApplicationWithRepositories,
modelClass: typeof Model & {prototype: Model},
config: ModelApiConfig,
): Promise
// define repository setup here
// ...
// define controller setup here
// ...
}
}
``
See
all contributors.
MIT