swagger-api/swagger-codegen

Add auto-generated documentation

Open

#2.359 aberto em 11 de mar. de 2016

Ver no GitHub
 (13 comments) (1 reaction) (0 assignees)HTML (5.474 forks)batch import
Client: BashClient: C++Client: ClojureClient: Flash/ActionScriptClient: GroovyClient: ScalaClient: SwiftClient: TypeScriptEnhancement: FeatureFeature List: API clientsFeature: Documentationhelp wanted

Métricas do repositório

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

Description

We've add capabilities to generate documentation files (markdown) for API and model files in the Perl code generator: #2320, #2343

If anyone has cycle to add the documentation to the following languages, please reply to let us know:

Guia do colaborador

Direção de pesquisa
Examine a implementação existente de geração de documentação para Perl (PRs vinculados) e implemente algo semelhante para o idioma escolhido (Bash, C++, etc.). Certifique se de atualizar os modelos do gerador de código e adicionar os testes necessários.
Pilha de tecnologia
java
Domain
documentation
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.
1-2 dias
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
Basic programming skillsFamiliarity with chosen languageUnderstanding of Swagger/OpenAPI
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70