swagger-api / swagger-api/swagger-codegen
Go Client Markdown files do not contain example code
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
All of the generators (e.g. NodeJS, Python, Ruby, C#, Java, etc.) generate example code in the Markdown .md files. Except for the Go generator, which does not generate example code in the Markdown files. This is a huge gap as it makes it hard for Go developers to learn how to use a package generated in Go.
Description
See above
Swagger-codegen version
2.4.11
Swagger declaration file content or url
https://api.cloudmersive.com/swagger/api/validate
Command line used for generation
& java -jar swagger-codegen-cli-2.4.11.jar generate -i https://api.cloudmersive.com/swagger/api/validate -l go -c packageconfig.json
Steps to reproduce
See above
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue with swagger-codegen-cli-2.4.11 using the provided Cloudmersive Swagger URL, the Go language option, and packageconfig.json. Trace the Go generator's Markdown output and compare it with the example code produced by the other generators; done means generated Go Markdown files include usable example code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100