@4geit/swg-timeslots-path
Version:
timeslots endpoint specification
49 lines (37 loc) • 1.45 kB
Markdown
# @4geit/swg-timeslots-path [](//badge.fury.io/js/@4geit%2Fswg-timeslots-path)
---
timeslots endpoint specification
## Installation
1. A recommended way to install ***@4geit/swg-timeslots-path*** is through [npm](//www.npmjs.com/search?q=@4geit/swg-timeslots-path) package manager using the following command:
```bash
npm i @4geit/swg-timeslots-path --save
```
Or use `yarn` using the following command:
```bash
yarn add @4geit/swg-timeslots-path
```
2. In your swagger file, you need to add a reference to the `SwgTimeslotsPath` definition under the `paths` property (e.g. `/api/swagger/swagger.yaml`) as below:
```yaml
swagger: "2.0"
# ...
paths:
/timeslots:
$ref: ../../node_modules/@4geit/swg-timeslots-path/swagger.yaml#/definitions/SwgTimeslotsPath
# ...
```
And you will also need to add the path to the `controllers` folder of the `swg-timeslots-path` package so that swagger-node will find the relevant controller to use. Edit the file `/config/default.yaml` and add two new paths to the properties `mockControllersDirs` and `controllersDirs` as illustrated below:
```yaml
swagger:
# ...
bagpipes:
_router:
# ...
mockControllersDirs:
# ...
- node_modules/@4geit/swg-timeslots-path/mocks
# ...
controllersDirs:
# ...
- node_modules/@4geit/swg-timeslots-path/controllers
# ...
```