Dokument pdf/binary response im RAML

Question

Ich schreibe gerade eine Dokumentation für eine API, die ein json oder ein pdf (binär) zurückgibt, basierend auf dem Accept-Header, der an das System gesendet wird.

Wie kann ich angeben, dass die Antwort vom Typ binär oder ähnlich ist?

Answer 1

In der RAML Spec fand ich die type: file, die zu sein scheint, was ich suchte. Siehe https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#file

Answer 2

Sie müssen die möglichen Antworten wie folgt definieren.

responses: 
    200: 
     body: 
     application/octet-stream: 
     ....... 
     application/json: 
     ........ 

Zusätzlich können Sie ACCEPT-Header mit der Aufzählung der möglichen Inhaltstypen angeben.

 headers: 
     Accept: 
       type: string 
       enum: [application/octet-stream, application/json] 
      required: true