swagger-api/swagger-codegen

[Question] Can I define the response-example

Open

#3.907 geöffnet am 30. Sept. 2016

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Enhancement: FeatureGeneral: Questionhelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Untersuche, wie swagger codegen derzeit Antwortbeispiele aus der OpenAPI Spezifikation verarbeitet, und erkunde, ob es eine Möglichkeit gibt, benutzerdefinierte Beispiele für das Mocking zu definieren und zu verwenden.
Tech Stack
javarest api
Domain
apidocumentationbackend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
OpenAPI/SwaggerJava
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60