Swagger configuration module for the API.
Contains an object with essential parameters to configure swagger.
- Description:
- Swagger configuration module for the API.
Contains an object with essential parameters to configure swagger.
- Source:
Members
(static, constant) swaggerOptions :Object
- Description:
- Swagger configuration object
- Source:
Properties:
| Name |
Type |
Description |
definition |
definition
|
The OpenAPI definition object.
Properties
| Name |
Type |
Description |
openapi |
string
|
The OpenAPI version. |
info |
object
|
Information about the API. |
tags |
array
|
Tags for the API operations. |
servers |
array
|
Servers where the API is hosted. |
components |
object
|
Components for the API (Schemas and responses). |
|
apis |
object
|
Paths to the YAML files containing the API documentation. |
Swagger configuration object
Type:
(inner, constant) swaggerDocs :Object
- Description:
- Swagger documentation object generated from the YAML files.
It combines the paths from the loaded YAML files into a single object.
- Source:
Properties:
| Name |
Type |
Description |
definition |
Object
|
The main Swagger definition object, containing metadata.
Properties
| Name |
Type |
Description |
paths |
Object
|
Combined paths from different Swagger YAML files. |
|
Swagger documentation object generated from the YAML files.
It combines the paths from the loaded YAML files into a single object.
Type: