generator-jhipster-swagger2markup
![Dependency Status](https://david-dm.org/atomfrede/generator-jhipster-swagger2markup.svg?theme=shields.io)
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.
Installation
As this is a JHipster module, we expect you have JHipster and its related tools already installed.
npm install -g generator-jhipster-swagger2markup
Then run the module on a JHipster generated application:
yo jhipster-swagger2markup
If you want don't want to answer each question you can use
yo jhipster-swagger2markup default
to setup HTML5
backend and asciidoc
sample chapter.
Gradle
This plugin adds new tasks to your gradle build system
The generated static documentation can be found in build/asciidoc
as html or pdf.
Maven
The html or pdf generation is bound to the install
lifecycle phase.
The generated static documentation can be found in target/asciidoc
as html or pdf.
Limitation
As the latest swagger2markup-maven-plugin
is not properly deployed to maven central grouping by tag doesn't work with maven yet.
Result
![resulting html documentation](https://raw.githubusercontent.com/atomfrede/generator-jhipster-swagger2markup/master/screen-api.png)
License
Apache-2.0 © Frederik Hahne