2017-11-08 4 views
0

Verwenden von Knoten Dredd gegen meine API. Ich entschied mich für die Verwendung von XML-Datei, da dies eine Standard ist, die mit meinem Team vertraut ist.Mehrere Anfragen mit dredd yml

Hier ist ein Beispiel Schnipsel wir richtig funktioniert haben:

/api/station/{id}: 
    get: 
     produces: 
     - application/json; charset=utf-8 
     parameters: 
     - name: id 
     in: path 
     required: true 
     type: string 
     description: DynamoDB ID of the station to edit 
     x-example: 'daf04a00-c3bf-11e7-a913-b76623d265c4' 
     responses: 
     200: 
      description: Returns a single station 
      schema: 
      $ref: '#/definitions/station' 

Ich denke, ich kann erraten, wie alternative Antwortobjekt zu definieren, gehe ich davon aus dem Objekt zB fügen Sie einfach:

responses: 
    200: 
     description: Returns a single station 
     schema: 
     $ref: '#/definitions/station' 
    422: 
     description: Failed validation 

In Die Dredd-Dokumentation: https://dredd.readthedocs.io/en/latest/how-to-guides.html#multiple-requests-and-responses-within-one-api-blueprint-action

Es gibt ein Beispiel, wie mehrere Anforderungen an den gleichen Endpunkt gesendet werden. Dies ist jedoch für das API-Blueprint-Format und nicht y aml.

Kann jemand mehrere Anforderungen an den gleichen Endpunkt im YAML-Format übergeben? Ich kann keine Dokumente auf sehen, wie diese in docs unter dem Abschnitt

Antwort

0

Recht tun verknüpfen Sie sich Testing non-2xx Responses with Swagger:

Das Swagger Format ermöglicht es, mehrere Antworten für eine einzelne Operation zu spezifizieren. Standardmäßig testet Dredd nur Antworten mit 2xx Statuscodes. Antworten mit anderen Codes sind markiert als übersprungen und können in Hooks aktiviert werden - siehe Testen von Nicht-2xx-Antworten mit Swagger.

Default responses werden von Dredd ignoriert. Außerdem wird ab sofort nur application/json Medientyp in produces und consumes unterstützt. Andere Medientypen werden übersprungen.

+0

Ah, wie der Titel oben für seinen Zweck für den Bauplan offensichtlich war .. der folgende Titel wurde verpasst. Ich habe zu diesem Zeitpunkt eine Pull-Anforderung an die Dokumente gesendet, die hoffentlich anderen helfen könnte. – John