# generator-node-restify-aws-swagger

> Yeoman based generator for restify based API that includes AWS SDK & Swagger documentation & Sub generators

Latest version **0.1.13** (published 2015-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-node-restify-aws-swagger
pnpm add generator-node-restify-aws-swagger
yarn add generator-node-restify-aws-swagger
bun add generator-node-restify-aws-swagger
```

## 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.1.13 |
| Published | 2015-03-28 |
| First published | 2015-03-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | James A B Gray |
| Maintainers | pvblicltd |
| Keywords | yeoman-generator |

## Links

- npm: https://www.npmjs.com/package/generator-node-restify-aws-swagger
- Repository: https://github.com/pvblicltd/generator-node-restify-aws-swagger
- Issues: https://github.com/pvblicltd/generator-node-restify-aws-swagger/issues
- npm.io page: https://npm.io/package/generator-node-restify-aws-swagger

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ~0.4.0
- [yosay](https://npm.io/package/yosay.md) ^0.1.0
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ~0.16.0

## Recent versions

- 0.1.13 (latest) — 2015-03-28
- 0.1.12 — 2015-03-28
- 0.1.1 — 2015-03-28
- 0.1.0 — 2015-03-28

## README

# generator-node-restify-aws-swagger
[![Build Status](https://api.travis-ci.org/pvblicltd/generator-node-restify-aws-swagger.svg?branch=master)](https://api.travis-ci.org/pvblicltd/generator-node-restify-aws-swagger)  [![NPM version](https://badge.fury.io/js/generator-node-restify-aws-swagger.png)](http://badge.fury.io/js/generator-node-restify-aws-swagger)

[![Npm Downloads](https://nodei.co/npm/generator-node-restify-aws-swagger.png?downloads=true&stars=true)](https://nodei.co/npm/generator-node-restify-aws-swagger.png?downloads=true&stars=true)

A [Yeoman](http://yeoman.io) based generator for a restify based API project. Includes a madlib XDM provider, swagger based documentation, bunyan based logger and json based configuration file that is generated on first run.


## Getting Started

Validation uses: https://github.com/z0mt3c/node-restify-validation

API documentation is based on Swagger: https://github.com/wordnik/swagger-spec

Unit testing is done with Mocha: https://github.com/mochajs/mocha
Assertion library used is chai: https://github.com/chaijs/chai

Code coverage is done with blanket.js: https://github.com/alex-seville/blanket/
With the mocha cobertura reporter: https://github.com/sjonnet19/mocha-cobertura-reporter

The GruntFile will produce an output that can be hooked up to a Jenkins project.
Artifacts end up in: dist/artifacts
Unit test results are in dist/coverage/test-results.xml
Coverage report is in dist/coverage/coverage.xml

You need the cobertura plugin installed on Jenkins for the coverage report result to show in your project. An HTML version is also generated of the coverage report in dist/coverage/coverage.html.

The script to build in jenkins would be:
```bash
npm install
npm test
```

During development you can get a console based unit test result with `grunt test`. The `npm test` script is hooked up to the `grunt coverage` tasks to generate all the reports and coverage files for a Jenkins project.

There is a sub-generator available to create new routes of the API. Run `yo node-restify-aws-swagger:route` to start it.

### CoffeeScript based

This generator used to have a JavaScript or CoffeeScript choice option. I decided to take it out because it became too much work to maintain both variants and I didn't really use the pure JavaScript version myself. So any code or updates I wrote would only be tested for the CoffeeScript version.

### What is Yeoman?

Trick question. It's not a thing. It's this guy:

![](http://i.imgur.com/JHaAlBJ.png)

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*

```bash
$ npm install -g yo
```

### Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-madlib-restify-api from npm, run:

```bash
$ npm install -g node-restify-aws-swagger
```

Finally, initiate the generator:

```bash
$ yo node-restify-aws-swagger
```

### Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).


## License

MIT

---
_Source: https://npm.io/package/generator-node-restify-aws-swagger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._