swagger-api/swagger-codegen

Documentation generator for JS client?

Open

#2,079 opened on Feb 9, 2016

View on GitHub
 (7 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: JavaScript/Node.jsEnhancement: Featurehelp wanted

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?

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptJSDoc/ESDocSwagger codegen
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Investigate the generated JavaScript client code from swagger codegen and test various documentation generators like JSDoc, ESDoc, and YUIDoc with different configuration options. Review the issue comments for any hints or workarounds. Consider using TypeDoc if the client has TypeScript definitions, or explore generating Markdown documentation directly from the OpenAPI spec.