swagger-api/swagger-codegen

Add auto-generated documentation

Open

#2359 aperta il 11 mar 2016

Vedi su GitHub
 (13 commenti) (1 reazione) (0 assegnatari)HTML (5474 fork)batch import
Client: BashClient: C++Client: ClojureClient: Flash/ActionScriptClient: GroovyClient: ScalaClient: SwiftClient: TypeScriptEnhancement: FeatureFeature List: API clientsFeature: Documentationhelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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:

Guida contributor

Direzione di ricerca
Esamina l'implementazione esistente della generazione della documentazione per Perl (PR collegate) e realizza una implementazione simile per il linguaggio scelto (Bash, C++, ecc.). Assicurati di aggiornare i template del generatore di codice e aggiungere i test necessari.
Tech stack
java
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Basic programming skillsFamiliarity with chosen languageUnderstanding of Swagger/OpenAPI
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70