@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
31 lines (21 loc) • 1.22 kB
Markdown
lang: en
title: 'API docs: openapi-v3.controllerspec'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/openapi-v3
permalink: /doc/en/lb4/apidocs.openapi-v3.controllerspec.html
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/openapi-v3](./openapi-v3.md) > [ControllerSpec](./openapi-v3.controllerspec.md)
## ControllerSpec interface
<b>Signature:</b>
```typescript
export interface ControllerSpec
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [basePath?](./openapi-v3.controllerspec.basepath.md) | string | <i>(Optional)</i> 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?](./openapi-v3.controllerspec.components.md) | ComponentsObject | <i>(Optional)</i> OpenAPI components.schemas generated from model metadata |
| [paths](./openapi-v3.controllerspec.paths.md) | PathObject | The available paths and operations for the API. |