swagger-api / swagger-api/swagger-codegen
[Question] Can I define the response-example
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
Can I define the response-example in swagger.json, and use codeGen to mock the request and the response.As example: I define the result of the api [GET]/pet/{petId}, and the pet's name is "xiaoming" of the invoke result.I hope to get the result as this: {name:"xiaoming"}.
Also ,I hope to get the result as {name: "xiaohong"} when I define the pet's name as "xiaohong".
Is there any feature like this in swagger-editor or codegen?
Thank you for your reply very much!!!
Swagger-codegen version
Swagger declaration file content or url
Command line used for generation
Steps to reproduce
Related issues
Suggest a Fix
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 reviewing the Swagger declaration for GET /pet/{petId} and the response-example capabilities mentioned for swagger-editor and codegen. Determine whether named response examples can drive generated mock responses, and document or implement the behavior so changing the pet name produces the corresponding response.
Written by the indexing model from the issue text.
Assessment
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100