2015-07-16 17 views
6

Sto cercando di creare risposte di esempio per un endpoint con Swagger 2.0.Esempi di API JSON in Swagger 2.0

200: 
     description: Successful response 
     schema: 
     type: object 
     $ref: "#/definitions/User" 
     examples: 
     application/vnd.api+json: 
      - data: 
       attributes: 
        full_name: John Appleseed 
      - data: 
       attributes: 
        full_name: Mike Appleseed 

mio api consuma e produce application/vnd.api+json, ma non lo riconoscerà. Se elimino gli esempi, le mie specifiche funzionano. Qualche idea su come specificarlo?

error

+1

Ciò è dovuto a un bug esistente nello schema JSON utilizzato per la convalida. Mentre è stato risolto, ci vorrebbero alcuni giorni prima che l'editor venga aggiornato con esso. – Ron

risposta

8

È not fully implemented yet, anche se è possibile definire un unico esempio come questo:

responses: 
    "200": 
     description: Successful response 
     schema: 
     $ref: '#/definitions/User' 
     examples: 
     application/json: 
      data: 
      id: 1 
      attributes: 
       attr1: value1 
       attr2: value2 

c'è un bug relativo con il mime-type, non è possibile utilizzare i punti ecco perché non l'ho fatto put application/vnd.api + json

+0

Non potresti usare le virgolette? –