@hapiness/swag
Version:
Generate swag documentation for Hapiness' components
182 lines (144 loc) • 5.95 kB
Markdown
<img src="http://bit.ly/2mxmKKI" width="500" alt="Hapiness" />
<div style="margin-bottom:20px;">
<div style="line-height:60px">
<a href="https://travis-ci.org/hapinessjs/swag-module.svg?branch=master">
<img src="https://travis-ci.org/hapinessjs/swag-module.svg?branch=master" alt="build" />
</a>
<a href="https://coveralls.io/github/hapinessjs/swag-module?branch=master">
<img src="https://coveralls.io/repos/github/hapinessjs/swag-module/badge.svg?branch=master" alt="coveralls" />
</a>
<a href="https://david-dm.org/hapinessjs/swag-module">
<img src="https://david-dm.org/hapinessjs/swag-module.svg" alt="dependencies" />
</a>
<a href="https://david-dm.org/hapinessjs/swag-module?type=dev">
<img src="https://david-dm.org/hapinessjs/swag-module/dev-status.svg" alt="devDependencies" />
</a>
</div>
<div>
<a href="https://www.typescriptlang.org/docs/tutorial.html">
<img src="https://cdn-images-1.medium.com/max/800/1*8lKzkDJVWuVbqumysxMRYw.png"
align="right" alt="Typescript logo" width="50" height="50" style="border:none;" />
</a>
<a href="http://reactivex.io/rxjs">
<img src="http://reactivex.io/assets/Rx_Logo_S.png"
align="right" alt="ReactiveX logo" width="50" height="50" style="border:none;" />
</a>
<a href="http://hapijs.com">
<img src="http://bit.ly/2lYPYPw"
align="right" alt="Hapijs logo" width="75" style="border:none;" />
</a>
</div>
</div>
# Swag Module
`Swag` module for the [Hapiness](https://github.com/hapinessjs/hapiness).
## Table of contents
* [Using your module inside Hapiness application](#using-your-module-inside-hapiness-application)
* [Yarn or NPM it in your package.json](#yarn-or-npm-it-in-your-packagejson)
* [Import SwagModule from the library](#import-swagmodule-from-the-library)
* [Add documentation to your routes](#add-documentation-to-your-routes)
* [Contributing](#contributing)
* [Change History](#change-history)
* [Maintainers](#maintainers)
* [License](#license)
## Using your module inside Hapiness application
### `yarn` or `npm` it in your `package.json`
```bash
$ npm install --save @hapiness/core @hapiness/swag rxjs
or
$ yarn add @hapiness/core @hapiness/swag rxjs
```
```javascript
"dependencies": {
"@hapiness/core": "^1.2.2",
"@hapiness/swag": "^1.1.0",
//...
}
//...
```
### import `SwagModule` from the library
```javascript
import { Hapiness, HapinessModule, HttpServerExt, Route, OnGet } from '@hapiness/core';
import { SwagModule } from '@hapiness/swag';
@Route({
method: 'GET',
path: '/todo',
config: {
plugins: {
'hapi-swagger': {
'x-custom-values': {
'scope': 'todo.read',
},
'x-toto': 'tata'
}
},
description: 'Get todo',
notes: 'Returns todo item',
tags: ['api', 'todo']
}
})
class GetTodo implements OnGet {
onGet(request, reply) {
reply('I am a todo');
}
}
@HapinessModule({
version: '1.0.0',
imports: [
SwagModule.setConfig({ info: { title: 'Todo Service' } })
],
declarations: [ GetTodo ]
})
class HapinessModuleApp {
}
Hapiness.bootstrap(HapinessModuleApp, [
HttpServerExt.setConfig({ host: '0.0.0.0', port: 4443 })
]);
```
[Back to top](#table-of-contents)
## Add documentation to your routes
To get a complete list of allowed configuration for your route, you can follow what has been there [hapi-swagger](https://github.com/reptilbud/hapi-swagger)
To get the JSON format of your documentation, just go to the url `YOUR_SERVICE_HOST:YOUR_SERVICE_PORT/swagger.json`
To access the swagger interface of your documented endpoints, just go to the url `YOUR_SERVICE_HOST:YOUR_SERVICE_PORT/documentation`
and you will be able to test them
[Back to top](#table-of-contents)
## Contributing
To set up your development environment:
1. clone the repo to your workspace,
2. in the shell `cd` to the main folder,
3. hit `npm or yarn install`,
4. run `npm or yarn run test`.
* It will lint the code and execute all tests.
* The test coverage report can be viewed from `./coverage/lcov-report/index.html`.
[Back to top](#table-of-contents)
## Change History
* v1.1.0 (2017-11-20)
* Latest packages' versions.
* Documentation.
* Change packaging process.
* v1.0.0 (2017-10-27)
* Add possibility to have `x-*` as values
* Documentation
* First stable version
[Back to top](#table-of-contents)
## Maintainers
<table>
<tr>
<td colspan="4" align="center"><a href="https://www.tadaweb.com"><img src="http://bit.ly/2xHQkTi" width="117" alt="tadaweb" /></a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/Juneil"><img src="https://avatars3.githubusercontent.com/u/6546204?v=3&s=117" width="117"/></a></td>
<td align="center"><a href="https://github.com/antoinegomez"><img src="https://avatars3.githubusercontent.com/u/997028?v=3&s=117" width="117"/></a></td>
<td align="center"><a href="https://github.com/reptilbud"><img src="https://avatars3.githubusercontent.com/u/6841511?v=3&s=117" width="117"/></a></td>
<td align="center"><a href="https://github.com/njl07"><img src="https://avatars3.githubusercontent.com/u/1673977?v=3&s=117" width="117"/></a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/Juneil">Julien Fauville</a></td>
<td align="center"><a href="https://github.com/antoinegomez">Antoine Gomez</a></td>
<td align="center"><a href="https://github.com/reptilbud">Sébastien Ritz</a></td>
<td align="center"><a href="https://github.com/njl07">Nicolas Jessel</a></td>
</tr>
</table>
[Back to top](#table-of-contents)
## License
Copyright (c) 2017 **Hapiness** Licensed under the [MIT license](https://github.com/hapinessjs/empty-module/blob/master/LICENSE.md).
[Back to top](#table-of-contents)