swagger-api/swagger-codegen

[Question] Can I define the response-example

Open

#3,907 opened on Sep 30, 2016

View on GitHub
 (5 comments) (0 reactions) (0 assignees)HTML (5,474 forks)batch import
Enhancement: FeatureGeneral: Questionhelp wanted

Repository metrics

Stars
 (12,701 stars)
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

Research direction
Investigate how swagger codegen currently handles response examples from the OpenAPI spec and explore if there is a way to define and use custom examples for mocking.
Tech stack
javarest api
Domain
apidocumentationbackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
OpenAPI/SwaggerJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60