swagger-api/swagger-codegen

[Question] Can I define the response-example

Ouverte

#3 907 ouverte le 30 sept. 2016

Voir sur GitHubGuide contributeur
 (5 commentaires) (0 réaction) (0 personne assignée)HTML (5 474 forks)batch import
Enhancement: FeatureGeneral: Questionhelp wanted

Métriques du dépôt

Stars
 (12 701 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Étudiez comment swagger codegen gère actuellement les exemples de réponse de la spécification OpenAPI et explorez s'il existe un moyen de définir et d'utiliser des exemples personnalisés pour le mockage.
Stack technique
javarest api
Domaine
apidocumentationbackend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
OpenAPI/SwaggerJava
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60