New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation #3

Open

mcupak opened this issue Apr 26, 2016 · 0 comments

Owner

mcupak commented Apr 26, 2016

Create interactive as well as printable documentation based on Swagger.

Steps:

Annotate resources with Swagger annotations.
Create a maven profile using swagger-maven-plugin to generate swagger.json.
Use Swagger UI to display interactive documentation based on swagger.json.
Use swagger2markup-maven-plugin to convert output of swagger-maven-plugin to asciidoc.
Use asciidoctor-maven-plugin to convert asciidoc to html5 and pdf using the respective backends in the plugin configuration.

mcupak assigned mcupak and artemik and unassigned mcupak

mcupak mentioned this issue

Use Beacon API To Generate REST Documentation #8

Closed

mcupak unassigned artemik

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment