Page Contents

Home > @loopback/openapi-v3 > ControllerSpec

ControllerSpec interface

Signature:

export interface ControllerSpec 

Properties

Property Modifiers Type Description
[basePath?](/doc/en/lb4/apidocs.openapi-v3.controllerspec.basepath.html) string _(Optional)_ The base path on which the Controller API is served. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/).
[components?](/doc/en/lb4/apidocs.openapi-v3.controllerspec.components.html) ComponentsObject _(Optional)_ OpenAPI components.schemas generated from model metadata
[paths](/doc/en/lb4/apidocs.openapi-v3.controllerspec.paths.html) PathObject The available paths and operations for the API.