swagger-api/swagger-codegen

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

Open

#3.499 aberto em 2 de ago. de 2016

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (5.474 forks)batch import
Client: JavaEnhancement: Featurehelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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

Guia do colaborador

Direção de pesquisa
Examine os arquivos pom.mustache existentes para as bibliotecas listadas (feign, jersey2, retrofit, retrofit2, okhttp gson) e adicione a configuração do plugin maven javadoc plugin semelhante ao exemplo jersey1 do PR #3482.
Pilha de tecnologia
java
Domain
backend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaMavenSwagger Codegen
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50