# @sigodenjs/dee-swaggerize

> swagger document driven route builder for dee framework

Latest version **0.2.6** (published 2018-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sigodenjs/dee-swaggerize
pnpm add @sigodenjs/dee-swaggerize
yarn add @sigodenjs/dee-swaggerize
bun add @sigodenjs/dee-swaggerize
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.6 |
| Published | 2018-09-03 |
| First published | 2018-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 20.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Sigoden Huang |
| Maintainers | sigoden |

## Links

- npm: https://www.npmjs.com/package/@sigodenjs/dee-swaggerize
- Repository: https://github.com/sigoden/dee-swaggerize
- Homepage: https://github.com/sigoden/dee-swaggerize#readme
- Issues: https://github.com/sigoden/dee-swaggerize/issues
- npm.io page: https://npm.io/package/@sigodenjs/dee-swaggerize

## Dependencies (10)

- [async](https://npm.io/package/async.md) ^2.6.1
- [enjoi](https://npm.io/package/enjoi.md) ^3.2.3
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.12.0
- [debuglog](https://npm.io/package/debuglog.md) ^1.0.1
- [@types/node](https://npm.io/package/@types/node.md) ^10.9.4
- [core-util-is](https://npm.io/package/core-util-is.md) ^1.0.2
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^2.2.1
- [swagger-schema-official](https://npm.io/package/swagger-schema-official.md) ^2.0.0-bab6bed
- [@types/swagger-schema-official](https://npm.io/package/@types/swagger-schema-official.md) ^2.0.10
- [@types/express-serve-static-core](https://npm.io/package/@types/express-serve-static-core.md) ^4.16.0

## Recent versions

- 0.2.6 (latest) — 2018-09-03
- 0.2.5 — 2018-09-03
- 0.2.4 — 2018-09-03
- 0.2.3 — 2018-09-02
- 0.2.2 — 2018-09-02
- 0.2.1 — 2018-09-02
- 0.2.0 — 2018-09-01
- 0.1.10 — 2018-08-31
- 0.1.8 — 2018-08-31
- 0.1.6 — 2018-07-24

## README

Dee-swaggerize 

## Usage

```js
var swaggerize = require('@sigodenjs/dee-swaggerize');
var express = require('express');
var bodyParser = require('body-parser');

var app = express();

app.use(bodyParser.json());

swaggerize(app, {
    // swagger 对象或路径
    api: require('./fixtures/defs/pets.json'),
    // 处理器函数，是一个对象，其每个属性对应一个接口操作。
    handlers: require('./handlers'),
    // 安全控制函数，是一个对象，其每个属性对应一个安全验证操作。
    security: require('./security'),
    // 处理解析出的 Route 对象
    routeIteratee: function(route) {
        return route;
    }
});
```

---
_Source: https://npm.io/package/@sigodenjs/dee-swaggerize · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._