2015-07-16 13 views
6

Ich versuche, Beispielantworten für einen Endpunkt mit Swagger 2.0 zu erstellen.JSON-API-Beispiele 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 

Mein api verbraucht und produziert application/vnd.api+json, aber es wird nicht erkannt. Wenn ich die Beispiele lösche, funktioniert meine Spezifikation. Irgendeine Idee, wie man es spezifiziert?

error

+1

Dies liegt an einem Fehler, der im JSON-Schema für die Validierung vorhanden war. Während es behoben wurde, würde es ein paar Tage dauern, bis der Editor damit aktualisiert wird. – Ron

Antwort

8

Es ist not fully implemented yet, obwohl man ein einziges Beispiel wie folgt definieren:

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

gibt es einen Fehler mit dem MIME-Typ bezogen, können Sie keine Punkte verwenden ist, warum ich es nicht täte put application/vnd.api + json

+0

Konnten Sie keine Anführungszeichen verwenden? –