# @coldrift/swagger-router-express

> Swagger router for express that supports hierarchiral middlewares

Latest version **1.0.0** (published 2019-12-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @coldrift/swagger-router-express
pnpm add @coldrift/swagger-router-express
yarn add @coldrift/swagger-router-express
bun add @coldrift/swagger-router-express
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-12-18 |
| First published | 2019-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Valery Kholodkov |
| Maintainers | coldrift |

## Links

- npm: https://www.npmjs.com/package/@coldrift/swagger-router-express
- Repository: https://github.com/coldrift/swagger-router-express
- Homepage: https://github.com/coldrift/swagger-router-express#readme
- Issues: https://github.com/coldrift/swagger-router-express/issues
- npm.io page: https://npm.io/package/@coldrift/swagger-router-express

## Dependencies (2)

- [braces](https://npm.io/package/braces.md) >=2.3.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.15

## Recent versions

- 1.0.0 (latest) — 2019-12-18
- 0.0.4 — 2019-10-18
- 0.0.3 — 2019-10-18
- 0.0.2 — 2019-10-18
- 0.0.1 — 2019-10-18

## README

# Swagger Express Router

Sets up express routes bound to middleware and controller functions out of a swagger document.

All routing is therefore driven from the swagger file.

## Installation

```
$ npm install --save @coldrift/swagger-router-express
```

## Example Swagger file

The following sample code will set up a **GET** endpoint with URL **http://localhost:8000/api/v1/test1** bound to the function named **test** in the controller module **controller1** proxied by middleware function **requireAuth** in middleware module **middleware1**.

Swagger document `swagger.json`

```yaml
swagger: "2.0"
info:
  version: "0.0.1"
  title: ""
  description: ""
basePath: /api/v1
consumes:
  - application/json
produces:
  - application/json
paths:
  /test1:
    get:
      x-controller: "controller1.test"
      x-middleware:
        - "middleware1.requireAuth"
      tags:
        - /test
      description:
      parameters:
      responses:
```

## How to set up routes with express

```javascript
const YAML = require('yaml-js');
const swaggerRouter = require('@coldrift/swagger-router-express');

const app = express();
const swaggerDocument = YAML.load(fs.readFileSync(path.join(__dirname, './swagger.yaml')))

// this makes the module use the basePath from the swagger document
// when setting up the routes (defaults to false). Makes sense if
// you are attaching swagger router to a nester router
const useBasePath = true;

const middlewareObj = {
    middleware1: require('./middleware/middleware1'),
    controller1: require('./controllers/controller1'),
    controller2: require('./controllers/controller2')
};

swaggerRouter.setUpRoutes(middlewareObj, app, swaggerDocument, useBasePath);
```

## Example of controllers and middleware

Example of a controller `controllers/controller1.js`

```javascript
'use strict';

exports.test = (req, res) => res.json({success: true});
```

Example of a middleware `middleware/middleware1.js`

```javascript
'use strict';

exports.requireAuth = (req, res, next) => {
  if(!res.headers["authorization"]) {
    return res.status(401);
  }

  next();
}

```

## License

MIT

---
_Source: https://npm.io/package/@coldrift/swagger-router-express · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._