Come definire enum in swagger.io?

Question

Qualcuno è riuscito a definire i possibili valori di "enum" nella scheda Modello nella versione 2.0 di swaggger? Esempio: http://petstore.swagger.wordnik.com/#!/pet/addPet ha un'opzione enum per la proprietà 'status' ma quell'esempio usa la versione 1.0 di swagger (in base alla versione swagger definita nell'oggetto JSON). Ho cercato di ottenere lo stesso risultato nella versione 2.0 ma senza fortuna, non sono sicuro che la documentazione sia corretta per questo.

Qualche suggerimento su questo?

Answer 1

"enum" funziona proprio come questo:

 { 
     "in": "query", 
     "name": "sample", 
     "description": "a sample parameter with an enum value", 
     "type": "string", 
     "enum": [ "1", "2"], 
     "required": true 
     } 

Come potete vedere, c'è un parametro di query chiamato sample di tipo stringa, e ha un enum affermando due valori possibili. In questo caso, l'esempio indica che il parametro è obbligatorio, pertanto l'interfaccia utente non mostrerà un valore vuoto come opzione.

Per un esempio funzionante di dimensioni minimali, provate questo:

{ 
    "swagger": "2.0", 
    "info": { 
    "title": "title", 
    "description": "descriptor", 
    "version": "0.1" 
    }, 
    "paths": { 
    "/sample": { 
     "post": { 
     "description": "sample", 
     "parameters": [ 
      { 
      "in": "query", 
      "name": "sample", 
      "description": "a sample parameter with an enum value", 
      "type": "string", 
      "enum": [ 
       "1", 
       "2" 
      ], 
      "required": true 
      } 
     ], 
     "responses": { 
      "200": { 
      "description": "Successful request." 
      } 
     } 
     } 
    } 
    } 
} 

verificarlo a livello locale, è possibile dichiarare una variabile (ad esempio spec) in Javascript, e passarlo nell'oggetto SwaggerUi.

var spec = { ... }; 

    window.swaggerUi = new SwaggerUi({ 
    url: url, 
    spec: spec, 
    dom_id: "swagger-ui-container", 
    supportedSubmitMethods: ['get', 'post', 'put', 'delete'], 
    onComplete: function(swaggerApi, swaggerUi){ 
    ... 

Il parametro url saranno ignorate in questo caso.

Alla fine, l'output è simile al seguente:

ero in grado di farlo in questo modo va bene, ma come si può vedere in immagine allegata di seguito per ogni params ha creato discesa:

Quello che voglio ottenere è bello tabs Modello/Modello Schema come su sull'immagine qui sotto con enumerazioni disponibili elencate per parametro. Questo è possibile nella versione più recente di Swagger:

Answer 2

questo dovrebbe funzionare:

{ 
    "name": "bookingType", 
    "in": "path", 
    "type": "array", 
    "items": { 
     "enum": [ 
      "packages", "accommodations" 
     ] 
    }, 
    "description": "lorem ipsum" 
} 

Riferimento https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#itemsObject

Answer 3

Questa non è la risposta esatta, ma potrebbe funzionare per voi fino a quando aggiungono questa funzionalità.

semplicemente dichiarare la proprietà in questo modo

"MyObject":{ 
    "properties":{ 
     "MyEnum":{ 
     "type":"Value1 or Value2 or Value3" 
     } 
    } 
} 

tuo ModelSchema mostrerà {}, ma il modello mostrerà MyEnum(Value1 or Value2 or Value3, optional)

Answer 4

L'aggiornamento di queste con la sintassi YAML:

in: query 
name: sample 
description: a sample parameter with an enum value 
type: string 
enum: 
    - 1 
    - 2 
required: true