generator-jhipster-swagger2markup [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]

> JHipster module to create static api docs with swagger2markup

Usage

This is a JHipster module, that is meant to be use in a JHipster application.

$3

As this is a JHipster module, we expect you have JHipster and its related tools already installed.

``bash
npm install -g generator-jhipster-swagger2markup
`

Then run the module on a JHipster generated application:

`bash
yo jhipster-swagger2markup
`

If you want don't want to answer each question you can use

`bash
yo jhipster-swagger2markup default
`

to setup HTML5 backend and asciidoc sample chapter.

$3

This plugin adds new tasks to your gradle build system

* gradlew asciidoctor

The generated static documentation can be found in build/asciidoc as html or pdf.

$3

The html or pdf generation is bound to the install lifecycle phase. The swagger2markup creation is not bound to any phase, therefore you must create it explicitly during the test phase and process the swagger file:

* mvnw test swagger2markup:convertSwagger2markup install

The generated static documentation can be found in target/asciidoc` as html or pdf.

$3

![resulting html documentation][result-image]

License

Apache-2.0 © Frederik Hahne

[npm-image]: https://badge.fury.io/js/generator-jhipster-swagger2markup.svg
[npm-url]: https://npmjs.org/package/generator-jhipster-swagger2markup
[travis-image]: https://travis-ci.org/atomfrede/generator-jhipster-swagger2markup.svg?branch=master
[travis-url]: https://travis-ci.org/atomfrede/generator-jhipster-swagger2markup
[daviddm-image]: https://david-dm.org/atomfrede/generator-jhipster-swagger2markup.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/atomfrede/generator-jhipster-swagger2markup
[result-image]: https://raw.githubusercontent.com/atomfrede/generator-jhipster-swagger2markup/master/screen-api.png