swagger-api / swagger-api/swagger-codegen

[PYTHON] Handling multiple responses with codegen

Aperta
#8,167 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Mustache
Stelle
17.8k
Fork
6k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I have different type of responses for different status code , consider the contents of swagger.json to be

{
	"swagger": "2.0",
	"info": {
		"title": "My Api",
		"description": "Api for Queue",
		"version": "v1"
	},
	"host": "localhost:8000",
	"schemes": ["http"],
	"basePath": "/api",
	"consumes": ["application/json"],
	"produces": ["application/json"],
	"securityDefinitions": {},
	"security": [{}],
	"paths": {
		"/v1/{name}/get_task": {
			"get": {
				"operationId": "v1_get_task_read",
				"description": "Get the first task from queue \n---",
				"parameters": [{
					"name": "priority",
					"in": "query",
					"required": false,
					"type": "string"
				}],
				"responses": {
					"200": {
						"description": "QueuedTask Object",
						"schema": {
							"$ref": "#/definitions/QueuedTask"
						}
					},
					"204": {
						"description": "null object response"
					}
				},
				"tags": ["v1"]
			},
			"parameters": [{
				"name": "name",
				"in": "path",
				"required": true,
				"type": "string"
			}]
		}
	},
	"definitions": {
		"QueuedTask": {
			"required": ["name"],
			"type": "object",
			"properties": {
				"id": {
					"title": "ID",
					"type": "integer",
					"readOnly": true
				},
				"name": {
					"title": "Name",
					"type": "string",
					"maxLength": 16
				}
			}
		}
	}
}
Swagger codegen version 2.3.1
java -jar swagger-codegen-cli-2.3.1.jar generate -l python -i swagger.json -o outs

swagger_client produced inside outs directory doesn't support None object for 204 response. It tries to deserialize the empty response into QueuedTask object and breaks.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Usa lo swagger.json fornito ed esegui il comando indicato per la generazione Python di Swagger Codegen 2.3.1. Esamina la gestione delle risposte 200 e 204 nello swagger_client generato, concentrandoti sulla risposta 204 vuota. Il lavoro è completato quando il client generato accetta la risposta 204 senza tentare di deserializzarla come QueuedTask, preservando al contempo il comportamento della risposta 200.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
api, tooling
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.