swagger-api/swagger-codegen

Documentation generator for JS client?

Ouverte

#2 079 ouverte le 9 févr. 2016

Voir sur GitHubGuide contributeur
 (7 commentaires) (0 réaction) (0 personne assignée)HTML (5 474 forks)batch import
Client: JavaScript/Node.jsEnhancement: Featurehelp wanted

Métriques du dépôt

Stars
 (12 701 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

The generated client code has nice documentation comments, but I haven't been able to produce any good output from it. Is there actually a JS api doc generator that produces any good output from these sources? I've tried ESDoc, JSDoc, and YUIDoc, and all came out with essentially empty output. Is there a magic tool/configuration combo that works?

Guide contributeur

Direction de recherche
Étudiez le code client JavaScript généré par swagger codegen et testez divers générateurs de documentation comme JSDoc, ESDoc et YUIDoc avec différentes options de configuration. Examinez les commentaires de l'issue pour tout indice ou solution de contournement. Envisagez d'utiliser TypeDoc si le client a des définitions TypeScript, ou explorez la génération directe de documentation Markdown à partir de la spécification OpenAPI.
Stack technique
javascript
Domaine
documentation
Type d'issue
Recherche
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
JavaScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60