swagger-api / swagger-api/swagger-codegen
Feature request: programmatically get example values for parameters
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
The Swagger UI often shows example values, which is really nice when you want to get a sample of what that endpoint can offer.
It would be really useful if this feature was also available in the generated code. It could be as simple as having a dictionary object that maps parameter names onto example values.
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
The issue mentions Swagger UI and generated code but names no files, target language, or tests. Start by locating how Swagger UI obtains example values and how the template-driven generator handles parameters. Done means generated code exposes a consistent mapping from parameter names to their example values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100