swagger-api/swagger-codegen

Codegen doesn't use "example" for response body

Open

#2,387 opened on Mar 15, 2016

View on GitHub
 (5 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Enhancement: FeatureServer: Nodejshelp wanted

Description

Not sure if this is by design or bug. I have example for every object under definitions section. When I use codegen to generate a nodejs server, I am hoping at least the response body for GET should use the example data, but it doesn't.

Example data shows up under "Response Class", but when I click "Try it out!", in stead of example data, I get generic json object generated by Codegen using the schema. Like {"userName": "aeiou"}

Do I miss anything? Thanks

Contributor guide

Tech stack
nodejs
Domain
apibackend
Issue type
bug
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.
mostly clear
Prerequisites
Understanding of OpenAPI/Swagger specFamiliarity with code generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate how the codegen processes the 'example' field from the OpenAPI spec for response bodies. Look at the template files (e.g., Mustache) and the Java code that builds the response model. Determine if the 'example' field is being ignored or if a special configuration is needed. Check similar issues or PRs for context.
Codegen doesn't use "example" for response body · swagger-api/swagger-codegen#2387 | Good First Issue