cancel
Showing results for 
Search instead for 
Did you mean: 

[newbie] how to generate static docs with maven?

Highlighted
New Contributor

[newbie] how to generate static docs with maven?

Hello,

I have a Java JAX-RS webservice, built with Maven.

The webservice runs in Thorntail (i.e. JBoss), if that matters.

Now, I cannot understand how to use Swagger exactly.

I already know how to annnotate classes properly.

I want to generate some HTML (not JSON or YAML!) static documentation of my webservices. Something similar to https://petstore.swagger.io. Possibly, I want to do that using Maven.

I have seen there is a third-party Maven plugin (https://github.com/kongchen/swagger-maven-plugin), however I would like to avoid third-party products.

I have found two interesting plugins, but I did not understand how to use them, nor if they are available in Maven Central Repository:

https://github.com/swagger-api/swagger-core/tree/master/modules/swagger-maven-plugin

https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen-maven-plugin

 

So, what is the intended way to generate docs?
Thank you.

 

 

1 REPLY 1
Moderator

Re: [newbie] how to generate static docs with maven?

Do you use swagger-core? If so, which version?


Did my reply answer your question? Give Kudos or Accept it as a Solution to help others.↓↓↓↓↓
New Here?
Join us and watch the welcome video: