naxbureau.blogg.se - Swagger editor

I was after something relatively quick and simple, minimal software install. The war plugin works on the generated documentation - as such, you must make sure that those plugins have been executed in an earlier phase. You can do this in the maven-war-plugin: If you want your generated html document to become part of your war file you have to make sure that it is present on the top level - static files in the WEB-INF folder will not be served. You can create one that simply collects the ones that were created by the swagger2markup plugin: include::/overview.adoc

The asciidoctor plugin assumes the existence of an. Please be aware that the order of execution matters, since the output of one plugin, becomes the input to the next:

Asciidoc -> PDF : asciidoctor-maven-plugin.

swagger.json -> Asciidoc : swagger2markup-maven-plugin.

rest-api -> swagger.json : swagger-maven-plugin.

It uses a series of plugins to generate a pdf and an html documentation (of the project's REST resources). If you have a Java Maven project you can use the pom snippet below.

You can modify your REST project, so as to produce the needed static documents (html, pdf etc) upon building the project.