swagger-api / swagger-api/swagger-codegen
README.md should be configurable
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
When generating code for a big api the generated README.md file gets very big as it includes every possible call as code example.
This causes issues when opening the file in github / other browser based renderer as they will freeze the browser for some time.
Swagger-codegen version
3.0.19
Steps to reproduce
- Generate a client for a big api
- Open README.md
Suggest a fix/enhancement
It should be possible to either
a) Configure the README.md generation so it only includes 1-2 samples
b) Split the code examples into separate files and link them
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
Start by tracing how README.md is generated for a large API and identify the templates or configuration entry points involved. Compare the generated README size and examples before and after the change; done means users can limit examples or split them into linked files without freezing browser-based renderers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100