swagger-api/swagger-codegen

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

Open

#3,499 opened on Aug 2, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: JavaEnhancement: Featurehelp wanted

Description

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

Contributor guide

Tech stack
java
Domain
documentationbuild system
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
MavenJavaSwagger Codegen repository structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Study the existing PR #3482 for jersey1 to understand the maven javadoc plugin configuration pattern. Apply similar changes to the five pom.mustache files listed: feign, jersey2, retrofit, retrofit2, and okhttp gson. After updating, verify by running `mvn javadoc:javadoc` in the generated client to ensure it works correctly.