generator-jhipster-swagger2markup
Advanced tools
JHipster module to create nice looking static api docs with swagger2markup
JHipster module to create static api docs with swagger2markup
This is a JHipster module, that is meant to be use in a JHipster application.
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.
This plugin adds new tasks to your gradle build system
gradlew asciidoctorThe generated static documentation can be found in build/asciidoc as html or pdf.
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:process-swagger installThe generated static documentation can be found in target/asciidoc as html or pdf.
As the latest swagger2markup-maven-plugin is not properly deployed to maven central grouping by tag doesn't work with maven yet.
Apache-2.0 © Frederik Hahne
FAQs
JHipster module to create nice looking static api docs with swagger2markup
The npm package generator-jhipster-swagger2markup receives a total of 30 weekly downloads. As such, generator-jhipster-swagger2markup popularity was classified as not popular.
We found that generator-jhipster-swagger2markup demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."