search

swagger-api / swagger-codegen

swagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.
http://swagger.io
Apache License 2.0
16.88k stars 6.03k forks source link

[Java] Add maven-javadoc-plugin in pom.xml of generated Java client #3499

Open wing328 opened 8 years ago

wing328 commented 8 years ago
Description

This plugin would allow the generation of Javadoc from the generated Java client using mvn javadoc:javadoc, making it easier to document the Java client API.

@cliffano has updated it for jersey1 Java API client via https://github.com/swagger-api/swagger-codegen/pull/3482

If anyone has time to update pom.xml for other Java API clients (listed below), please reply to let us know.

https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/feign/pom.mustache https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/jersey2/pom.mustache https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit/pom.mustache https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/pom.mustache https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache

wing328 commented 8 years ago

PR merged. Thanks for the contribution from @cliffano