swagger-api/swagger-codegen

Add auto-generated documentation

Open

#2 359 ouverte le 11 mars 2016

Voir sur GitHub
 (13 commentaires) (1 réaction) (0 assignés)HTML (5 474 forks)batch import
Client: BashClient: C++Client: ClojureClient: Flash/ActionScriptClient: GroovyClient: ScalaClient: SwiftClient: TypeScriptEnhancement: FeatureFeature List: API clientsFeature: Documentationhelp wanted

Métriques du dépôt

Stars
 (12 701 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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:

Guide contributeur

Direction de recherche
Examinez l'implémentation existante de génération de documentation pour Perl (PRs liées) et implémentez en une similaire pour le langage choisi (Bash, C++, etc.). Assurez vous de mettre à jour les modèles du générateur de code et d'ajouter les tests nécessaires.
Stack technique
java
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Basic programming skillsFamiliarity with chosen languageUnderstanding of Swagger/OpenAPI
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70