https://github.com/atomfrede/generator-jhipster-swagger2markup
JHipster module to create static api docs with swagger2markup
https://github.com/atomfrede/generator-jhipster-swagger2markup
Last synced: 25 days ago
JSON representation
JHipster module to create static api docs with swagger2markup
- Host: GitHub
- URL: https://github.com/atomfrede/generator-jhipster-swagger2markup
- Owner: atomfrede
- License: apache-2.0
- Created: 2015-12-07T13:11:45.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-13T10:57:00.000Z (over 7 years ago)
- Last Synced: 2025-03-17T19:52:26.784Z (28 days ago)
- Language: JavaScript
- Size: 385 KB
- Stars: 40
- Watchers: 5
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - atomfrede/generator-jhipster-swagger2markup - JHipster module to create static api docs with swagger2markup (JavaScript)
README
# 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](https://github.com/Swagger2Markup/swagger2markup)
## Usage
This is a [JHipster](http://jhipster.github.io/) module, that is meant to be use in a JHipster application.
### Installation
As this is a [JHipster](http://jhipster.github.io/) module, we expect you have [JHipster and its related tools already installed](http://jhipster.github.io/installation.html).
```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.
### Gradle
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.
### Maven
#### Requirements
You **must** add the `jcenter` repository to your `pom.xml`, otherwise some dependencies can't be resolved!
```xml
false
central
bintray
http://jcenter.bintray.com
```
#### Usage
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.
### Result
![resulting html documentation][result-image]
## License
Apache-2.0 © [Frederik Hahne](http://atomfrede.github.io/shiny-adventure/)
[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